MkDocs

MkDocs is a static site generator for project documentation written in Markdown. It is configured with a single YAML file and produces plain HTML that you can host anywhere.

You write pages as Markdown files in a folder, describe the navigation and settings in one YAML configuration file, and run MkDocs to build the site. A built-in development server reloads your browser when you save a file, so you can preview changes while you write. The output is ordinary static HTML, CSS and JavaScript, which keeps hosting simple.

• Write pages as plain Markdown files
• Configure the whole site in one YAML file
• Preview changes with a live-reloading server
• Choose from built-in and third-party themes
• Extend Markdown with additional extensions

MkDocs fits open source projects and internal engineering teams that want documentation next to their code. Python developers in particular tend to find its setup familiar. It is a simpler choice than a full web framework when the goal is clear, readable reference pages.

MkDocs is open source under the BSD-2-Clause license, so it costs nothing to use. You host the built site yourself, for example on GitHub Pages or Amazon S3, as the project itself suggests. Setup happens on the command line, and advanced behavior often depends on third-party themes or plugins, each with its own maintenance status.