mkdocs info
Python environment
sudo apt install -y git python3-pip python3-venv
python3 -m venv ~/envs/mkdocs
. envs/mkdocs/bin/activate
pip install \
mkdocs \
mkdocs-material \
mkdocs-glightbox \
mkdocs-material-extensions \
mkdocs-rss-plugin
External Resources
- https://stackoverflow.com/questions/27882261/mkdocs-and-mathjax
- https://www.mkdocs.org/user-guide/writing-your-docs/
- https://squidfunk.github.io/mkdocs-material/
- https://www.markdownguide.org/tools/mkdocs/
- https://facelessuser.github.io/pymdown-extensions/extensions/
load mathjax at the beginning:
strikethrough support:
markdown_extensions:
...
- pymdownx.tilde: {}
...
New Project
mkdocs new my-project
cd my-project