Skip to content

MkDocs

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

For full documentation visit mkdocs.org.

Material for MkDocs

A project that uses MkDocs as a base to implement an incredibly simple docs static (and/or dynamic) documentation site such as this.

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.