Versions Compared

Key

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

...

  • tunnel a port to chrysalis from your local machine (e.g., ssh -L 12345:localhost:12345 username@chrysalis.lcrc.anl.gov)

  • use e3sm-unified (e.g., source /lcrc/soft/climate/e3sm-unified/load_latest_e3sm_unified_chrysalis.sh)

  • develop the docs in your preferred editor

  • (optionally, starting in 1.10.0, use the linter, e.g., markdownlint-cli2 <my_md_files>)

  • starting in 1.9.3, use mkdocs serve with that port (e.g., mkdocs serve -a localhost:12345)

  • then, open the link it prints in your local browser (e.g., localhost:12345)

  • (note that you can continue editing and your edits should appear live in the browser window very shortly after making the edits)

Markdown style and linting

...