MkDocs
A static documentation generator using Markdown pages and a YAML project configuration.
About MkDocs
MkDocs is a static site generator for building project documentation. Documentation source files are written in Markdown and configured with a single YAML configuration file. It produces static HTML sites that can be hosted on GitHub Pages, Amazon S3, or other hosts.
The built-in development server lets authors preview pages while writing, and it reloads the browser when changes are saved. Themes can be chosen, customized, or extended with plugins and Markdown extensions. The project is open source.
Key features
- Documentation pages written in Markdown source files
- Single YAML configuration file for project settings
- Built-in mkdocs and readthedocs themes
- Third-party themes listed on the MkDocs Themes wiki and MkDocs Catalog
- Built-in dev server with auto-reload when files are saved
- Builds static HTML sites for hosting on GitHub Pages or Amazon S3
Best for: Software and project teams that want to write documentation in Markdown and publish it as a static website.
Good for
- Open source
- Produces static HTML that can be hosted on several services
- Live preview with automatic browser refresh while writing
MkDocs at a glance
- Website
- mkdocs.org
- Category
- Development › Developer Tools
- Type
- Online tool
- Pricing
- Free
- Open source
- Yes
- Last checked
- Oct 9, 2026 · Online when checked
- Listed
- Oct 9, 2026
Guides for Developer Tools
MkDocs alternatives
Tools and sites you could use instead, ranked by how closely they match.
A Markdown-based book and documentation generator for material organized in chapter order.
FreeOpen source
A documentation generator supporting structured references, cross-references and Python API documentation workflows.
FreeOpen source
7 alternativesHeritrix 3 documentation describes configuration and use of the Heritrix web crawler.
MkDocs comparisons
Featured in
8 sites
Best of
8 Best Documentation Site Generators for Product and Project Docs
For documentation site generators, I'd start with Docusaurus when product versions and interactive examples matter, and…
Popular in Developer Tools
Well-known listings from the same topic.
AppDevToolsappdevtools.comCommand Not Foundcommand-not-found.comTestFlighttestflight.apple.com/join/A8GwCnq8Sourcegraphabout.sourcegraph.comProject Wallaceprojectwallace.comCarbon Calculatorwebsitecarbon.com
MkDocs FAQ
How is a MkDocs project configured?
Documentation source files are written in Markdown and configured with a single YAML configuration file.
Where can a MkDocs site be hosted?
MkDocs builds completely static HTML sites that can be hosted on GitHub Pages, Amazon S3, or anywhere else the owner chooses.
Is something wrong or out of date?
Tell us and an editor will check it.
Own this website?
Claim this listing
Claim the listing and suggest updates yourself. An editor checks every claim first.