MkDocs
Fast, simple project documentation from markdown files.
MkDocs is a Python static site generator dedicated to project documentation: a folder of markdown files plus one small YAML config becomes a searchable docs site, previewed live with a built-in dev server.
The Material for MkDocs theme has become a de facto standard for open-source documentation, and one command deploys the built site straight to GitHub Pages.
Similar markdown tools
Docsify
Renders a docs site from markdown files on the fly — no build step.
Docusaurus
Meta's React-based documentation site generator powered by MDX.
GitBook
Hosted documentation platform that syncs with markdown in Git.
Teedoc
Static documentation site generator for multi-docs websites.
Wiki.js
Modern self-hosted wiki with a first-class markdown editor.
Writerside
JetBrains' documentation IDE with markdown authoring.
Try markdown before you install anything
The free online markdown editor gives you a live side-by-side preview in the browser — a quick way to test the syntax MkDocs uses, with nothing to download or sign up for.
Open the editor