Skip to content

mkdocs

pages-build-deployment

alias

  • serve with alias
alias mks='mkdocs serve'

click

  • serve with click
cli bujo m

citation1

- this[^1]
[^1]: requires software installation

includes

  • -8<- "includes/example.md"
  • embed docs on multiple pages
  • you can also splice in partial files using line numbers example.md:2:5
# example include

- this file is at: `includes/example.md`
- it can be rendered on any page using the example snippet

site wide glossary

  • mouse over this: PRAJNA
  • add more here: includes/abbreviations.md
pip install pymdown-extensions
python3 -m venv venv
source venv/bin/activate
pip install mkdocs mkdocs-material
mkdocs serve
pip show mkdocs-material
pip install --upgrade mkdocs-material
pip install --upgrade mkdocs-material

github actions

  • this site is deployed using this command mkdocs gh-deploy
  • github pages actions deploys updates on this branch gh-pages

p


  1. citations go here