Versions Compared

Key

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

...

You can install the linter on your local machine following the instructions at https://github.com/DavidAnson/markdownlint-cli2 (using homebrew, npm or a docker container).

(NOTE: We are working on bringing markdownlint-cli2 to conda-forge soon; in the meanwhile, it is possible to use markdownlint-cli2 from the mahf708 channel; to add it to the e3sm_docs conda env above, do: conda activate e3sm_docs and then conda install -c mahf708 makrdownlint-cli2. Once installed, it can be used like so: markdownlint-cli2 [FILE_OR_GLOB]where you should replace [FILE_OR_GLOB] with something like the path of a file or a wildcard/glob of some sort, e.g. */*.md or **/*.md.)

Documentation organization

...