Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 1.52 KB

README.md

File metadata and controls

41 lines (23 loc) · 1.52 KB

Data Request Documentation (Live)

MkDocs Build + Deploy Deploy static content to Pages

To View the main documentation: See drdocs.mipcvs.dev


For the CMIP-Data-Request development repository try cmip-data-request.github.io/DReq-Docs/


Editing the documentation.

Docmentation is found in the `docs` folder with the file names and hierarchy affecting the navigational menu. 

Editing materials.

  • menu/page name is determined by the # header tag at the top of a file.

Viewing an IPyNb online.

Steps to Convert:

Copy the GitHub notebook URL (e.g., https://github.com/user/repo/blob/main/path/to/notebook.ipynb).

Replace https://github.com with https://nbviewer.jupyter.org/github.

Ensure blob/ remains in the path for the nbviewer link to work correctly.

Resources

Demo files and structure:

https://github.com/selfhostedshow/wiki/tree/master

Permissable items

https://squidfunk.github.io/mkdocs-material/reference/admonitions/

developer notes

The following are Notes and will be tidied away in due course. https://squidfunk.github.io/mkdocs-material/getting-started/