MkDocs
Last updated
Was this helpful?
Last updated
Was this helpful?
Project documentation with Markdown.
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. Start by reading the , then check the for more information.
There's a stack of good looking available for MkDocs. Choose between the built in themes: and , select one of the third-party themes (on the wiki page as well as the ), or .
Get your project documentation looking just the way you want it by and/or installing some . Modify Markdown's behavior with . Many are available.
The built-in dev-server allows you to preview your documentation as you're writing it. It will even auto-reload and refresh your browser whenever you save your changes.
MkDocs builds completely static HTML sites that you can host on GitHub Pages, Amazon S3, or else you choose.