Skip to the content
Know your tech before you buy it. Makers: get listed from $49/mo

MkDocs

mkdocs.org

  • Free plan
  • Windows
  • macOS
  • Linux
  • Self-hosted
7.6 Club score Visit mkdocs.org

What MkDocs is

MkDocs is a free static site generator for project documentation written in Markdown and configured with a YAML file. It builds completely static HTML that can be hosted on GitHub Pages, Amazon S3 or another static-file provider. A built-in development server previews documentation locally and reloads after changes. Generated sites include search that can locate page text and link to matching sections. MkDocs provides the built-in mkdocs and readthedocs themes, while third-party and custom themes are also supported. Plugins, Markdown extensions and configuration options allow further customization. The tool uses Python-Markdown, requires a recent Python version and pip, and includes commands for creating, serving and building sites, getting dependencies and deploying to GitHub Pages. The built-in theme supports locales including English, German, Spanish, French, Japanese and Chinese. MkDocs runs on Linux, macOS, Windows and self-hosted setups and is distributed under the BSD license.

Who it suits

MkDocs suits people building project documentation sites from Markdown files. It works for teams wanting static hosting and local previews across common desktop platforms.

Good to know, and what to watch

  • Builds static HTML documentation
  • Local server reloads after edits
  • Supports built-in, third-party and custom themes
  • Includes page search
  • Deploys to GitHub Pages
  • Requires recent Python and pip
  • Plugins and themes execute unsandboxed code
  • Configuration uses YAML and Markdown

The verdict

MkDocs offers a straightforward Markdown-to-static-HTML workflow with themes, search and deployment options. Its unsandboxed extension model requires care when adding third-party themes or plugins.

What the maker publishes

Publishing audience
both source
Audience
MkDocs is intended for people building project documentation sites from Markdown files. source
CLI
The command-line interface provides build, get-deps, gh-deploy, new, and serve commands. source
Custom domain
Yes source
Customization
Themes, plugins, Markdown extensions, and configuration options can customize the generated documentation. source
Customization
Users can customize themes, install plugins, enable Markdown extensions, and configure many options. source
Deployment
MkDocs documents deployment to GitHub Pages and Read the Docs and states that any static-file hosting provider can be used. source
Deployment command
The command-line interface includes gh-deploy for deploying documentation to GitHub Pages. source
Free plan
Yes source
Hosting
Generated sites can be hosted on GitHub Pages, Amazon S3, or other hosting services. source
Installation
MkDocs requires a recent Python version and pip, and is installed with pip install mkdocs. source
Installation
MkDocs is installed with the Python package manager using pip install mkdocs. source
Integrations
MkDocs documentation can be deployed to GitHub Pages and hosted on Amazon S3. source
License
MkDocs is distributed under the BSD license, with copyright credited to Tom Christie. source
License
MkDocs is distributed under the BSD license, which permits redistribution and use in source and binary forms subject to its conditions. source
Live preview
The built-in development server previews documentation locally and automatically reloads after changes. source
Live preview
The built-in development server previews documentation and auto-reloads when files change. source
Localization
The built-in mkdocs theme supports multiple locales, including English, German, Spanish, French, Japanese, and Chinese. source
Markdown engine
MkDocs uses Python-Markdown to render Markdown and supports Markdown extensions. source
Output
MkDocs builds static HTML files that can be hosted on GitHub Pages, Amazon S3, or any other static-file host. source
Plugin ecosystem
Third-party plugins are installed as Python packages and can be listed in the MkDocs Catalog. source
Plugin security
MkDocs warns that plugins execute their authors' Python code and provides no sandboxing. source
Purpose
MkDocs is a fast static site generator for project documentation written in Markdown and configured with a YAML file. source
Purpose
MkDocs is a static site generator geared toward building project documentation from Markdown and a single YAML configuration file. source

Checked against the maker's pages on 1 Oct 2026.