MkDocs

https://www.mkdocs.org/arrow-up-right

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 introductory tutorialarrow-up-right, then check the User Guidearrow-up-right for more information.

Getting Startedarrow-up-right User Guidearrow-up-right

Features

Great themes available

There's a stack of good looking themesarrow-up-right available for MkDocs. Choose between the built in themes: mkdocsarrow-up-right and readthedocsarrow-up-right, select one of the third-party themes (on the MkDocs Themesarrow-up-right wiki page as well as the MkDocs Catalogarrow-up-right), or build your ownarrow-up-right.

Easy to customize

Get your project documentation looking just the way you want it by customizing your themearrow-up-right and/or installing some pluginsarrow-up-right. Modify Markdown's behavior with Markdown extensionsarrow-up-right. Many configuration optionsarrow-up-right are available.

Preview your site as you work

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.

Host anywhere

MkDocs builds completely static HTML sites that you can host on GitHub Pages, Amazon S3, or anywherearrow-up-right else you choose.

Last updated