...
conda create -n e3sm_docs mkdocs-material pymdown-extensions mkdocs-monorepo-plugin mdutils mkdocs-bibtex markdownlint-cli2
activate and use the environment with:
...
You can install the linter on your local machine by adding it to the conda environment above or following the instructions at https://github.com/DavidAnson/markdownlint-cli2 (using homebrew, npm or a docker container). (NOTE: We are working on bringing To run it, use 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 *<file-or-glob>
where <file-or-glob>
is markdown file (e.g., my_docs.md
) or a glob of files (e.g., my_new_docs/**/*.md
).)
Documentation organization
...