Skip to content

Admin links

For full documentation visit mkdocs.org.

Theme documentation

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.
  • mkdocs gh-deploy - Deploy site to GitHub Pages.

If jinja brokes

tweet

Just a warning to folks in the Python docs ecosystem. It looks like the latest version of jinja (which deprecated features properly) has broken the latest mkdocs & sphinx before 4.0. You can fix this by pinning jinja2<3.1.0 in your requirements