Versions Compared

Old Version 13

changes.mady.by.user Naser Mahfouz

Saved on

compared with

New Version 14

changes.mady.by.user Robert Jacob

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Our documentation is written in Markdown language. See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax to get started. NOTE: the Markdown files are converted to html. They will look different if you view them directly with a Markdown renderer.

Doing local development of documentation

...

(Follow the instructions output by the above command to display in your browser. control-C to end server)

NOTE: Don’t rely on direct Markdown viewers to see how things look. You need to look at the derived html because that is what will be served at github.io.

Expand
titleAn alternative to mkdocs serve

An alternative to mkdocs serve is to access to the docs directly without serving them through a URL. To achieve this, one could you file:///E3SM_ROOT/site/index.html in a modern browser like Chrome (in place of a URL). In this case, E3SM_ROOT is the full path to the clone E3SM repository on your local machine. One could directly go to other pages as needed using the same method (e.g., file:///E3SM_ROOT/site/EAM/index.html).

...

Code Block
languageyaml
site_name: EAM

nav:
 - Introduction: 'index.md'
 - Users's Guide: user-guide/index.md
 - Developers's Guide: dev-guide/index.md
 - Technical Guide: tech-guide/index.md

The “site_name” is a keyword used in the E3SM/docs/index.md file to reference all the model’s documentation. (That file must be edited when adding a new model’s documentation).

...