MkDocs is a fast, simple and downright gorgeous static site generator that’s geared towards building project documentation. The documentation source should be written as regular Markdown files.
Documentation source files are written in Markdown, and configured with a single YAML configuration file.
MkDocs is free and open source software.
Key Features
- Build static HTML files from Markdown files.
- Wide range of themes are available – choose between the built in themes: mkdocs and readthedocs, select one of the third-party themes listed on the MkDocs Themes wiki page, or build your own.
- Easy to customize – modify Markdown’s behavior with Markdown extensions. Many configuration options are available.
- Preview – built-in dev-server allows you to preview your documentation. It will rebuild your documentation whenever anything in the configuration file, documentation directory, or theme directory changes.
- Host anywhere – builds completely static HTML sites that you can host on GitHub pages, Amazon S3, or anywhere else you choose.
Website: www.mkdocs.org
Support: User Guide, GitHub Code Repository
Developer: MkDocs Team
License: BSD-2-Clause License
MkDocs is written in Python. Learn Python with our recommended free books and free tutorials.
Related Software
| Python Static Site Generators | |
|---|---|
| MkDocs | Project documentation with Markdown. It's easy to use and extensible |
| Pelican | Static site generator that supports Markdown and reST syntax |
| Sphinx | Create intelligent and beautiful documentation for Python projects |
| Lektor | Flexible and powerful static content management system |
| Nikola | Static website and blog generator |
| Bestatic | Really minimal yet feature-rich |
| Teedoc | Simple static website/document/blog generator |
| makesite | Simple, lightweight, and magic-free static site/blog generator |
| Prosopopee | Static site generator for your story |
| Grow | Declarative website generator |
| Hyde | Support for powerful template languages like Jinja2 |
| Cactus | Simple but powerful static website generator |
| Stapy | Works with Python on any operating system without additional packages. |
| Frozen-Flask | Freezes a Flask application into a set of static files |
| Blurry | Focused on page speed and SEO |
| Urubu | Micro content management system for static websites |
| Miyadaiku | Suitable for blogs, documentation, and other static publishing projects |
| incorporeal-cms | Lightweight static site generator for Markdown-based sites |
| blag | Blog-aware, static site generator which uses Markdown |
| wmk | Flexible and versatile static site generator |
| Pagegen | With reStructuredText or Markdown markup and Mako templates |
| Baku | Simple, Markdown-based blogging engine/static website generator |
| Aurora | Support for static and incremental builds |
| Genja | Uses Jinja templates for page rendering |
| StaticPipes | Flexible pipeline-based static site generator |
| Picogen | Minimalist static website generator with a simple workflow |
Read our verdict in the software roundup.
 Explore our carefully curated directory of recommended free and open source software, covering every major software category.The directory forms part of our extensive collection of articles for Linux enthusiasts. It includes hundreds of detailed reviews, together with free and open source alternatives to proprietary software from companies such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. LinuxLinks also covers interesting projects worth exploring, Linux-compatible hardware, free programming books and tutorials, and much more. Know a useful free and open source Linux application that we haven’t covered? Tell us about it using our submission form. |
Please read our Comment Policy before commenting.