Sign inCreate account
Sign inCreate account

mkdocs

From public sources

MkDocs is an open-source CLI static site generator that builds project documentation sites from Markdown files configured with a single YAML file.

CLI toolCategory: Developer Tools · Documentation toolsOpen sourcedata checked Oct 15, 2026
Add to compareAdd to collection

Overview

Project documentation is often scattered across wikis, READMEs and ad-hoc pages that are hard to keep current. MkDocs solves this by turning plain Markdown source files into a static HTML documentation site, configured through a single YAML file. MkDocs can be extended with third-party themes, plugins and Markdown extensions, and it includes built-in themes for a polished look out of the box. Its output is plain static files, so the finished documentation can be published anywhere static files can be served. MkDocs is aimed at developers and technical writers who want to maintain documentation alongside their code. It is written in Python, distributed under the BSD-2-Clause license, and used from the command line.
  • documentation
  • knowledge-base
  • markdown
  • mkdocs
  • python
  • static-site-generator

Installation

Commands are shown, never run by the marketplace. Check them against the official documentation.
  • Official websiteFrom public sourcesfrom catalog metadata
    www.mkdocs.org/ ↗
  • Language package registrypythonFrom public sourcesfrom the package manifest — publication on the registry is not verified
    pipx install mkdocs

    Not verified: check that this package in the registry belongs to this project before installing.

    pypi.org/project/mkdocs/ ↗
  • Build from sourceFrom public sourcesfrom catalog metadata

    Build from source: no validated build recipe — follow the repository instructions.

    github.com/mkdocs/mkdocs ↗

Compatibility

Unknown means no evidence was found — not that the product is incompatible.
PlatformStatusArchitectureEvidenceConfidence
WindowsUnknown———
macOSUnknown———
LinuxUnknown———
Container (OCI)Unknown———
Web browserCompatible—Declared on the card—
PythonCompatible—package manifest: pyproject.toml name0.60

Releases

checked Oct 29, 2026
v1.6.1LatestAug 30, 2024Official source ↗

Files in 1.6.1

This release has no attached files.

Release history

Quality profile

algorithm quality-v1.0 · assessed Oct 15, 2026
Quality Score73
Risk Score0
Confidence 1.00
Quality Score and Risk Score are different measures. A high score does not guarantee safety.

Score components

Maintenance · 206
last activity 360 days ago
Documentation · 1515
README 3117 chars, description present
Ready to use · 156
install instructions: no; releases: yes
Metadata · 1010
4/4 of description, homepage, license, topics
Releases · 106
10 release(s), latest 776 days ago
Category confidence · 1010
classifier confidence 1
Adoption · 1010
22501 stars (log-dampened, 10k = max)
License clarity · 55
SPDX BSD-2-Clause
Community · 55
issues enabled, 2657 forks

License

BSD-2-Clause
Known licensefrom the repository host

This is the catalog policy status, not legal advice.

Sources

github.com/mkdocs/mkdocsPrimary★ 22,501 starslast activity Oct 20, 2025Primary repository · Confidence 1.00

Reviews

Sign in to write a review

No reviews yet.

Alternatives

mkdocs-materialSimilar
Material for MkDocs is an open-source theme and framework for MkDocs that turns Markdown files into a searchable, responsive static documentation site.MIT · Developer Tools
docsifySimilar
Docsify is an open-source CLI documentation site generator that turns Markdown files into a website with no build step, for Developer Tools projects.MIT · Developer Tools
vitepressSimilar
VitePress is an open-source static site generator, powered by Vue and Vite, for building fast documentation sites from Markdown.MIT · Developer Tools
docusaurusSimilar
Docusaurus is an open-source CLI and React-based framework for building, deploying and maintaining documentation websites for software projects.MIT · Developer Tools
OCRmyPDFSimilar
OCRmyPDF is an open-source command-line tool that adds a searchable OCR text layer to scanned PDF files, turning them into PDF/A documents.MPL-2.0 · Developer Tools
reflexSimilar
🕸️ Web apps in pure Python 🐍Apache-2.0 · Developer Tools

README

From mkdocs/mkdocs · license BSD-2-Clause · fetched Oct 29, 2026

MkDocs

Project documentation with Markdown

[PyPI Version] [Build Status] [Coverage Status]

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. It is designed to be easy to use and can be extended with third-party themes, plugins, and Markdown extensions.

Please see the Documentation for an introductory tutorial and a full user guide.

Features

  • Build static HTML files from Markdown files.
  • Use Plugins and Markdown Extensions to enhance MkDocs.
  • Use the built-in themes, third party themes or create your own.
  • Publish your documentation anywhere that static files can be served.
  • Much more!

Support

If you need help with MkDocs, do not hesitate to get in contact with us!

  • For questions and high-level discussions, use Discussions on GitHub.
    • For small questions, a good alternative is the Chat room on Gitter/Matrix.
  • To report a bug or make a feature request, open an Issue on GitHub.

Please note that we may only provide support for problems/questions regarding core features of MkDocs. Any questions or bug reports about features of third-party themes, plugins, extensions or similar should be made to their respective projects.
But, such questions are not banned from the chat room.

Make sure to stick around to answer some questions as well!

Links

Contributing to MkDocs

The MkDocs project welcomes, and depends on, contributions from developers and users in the open source community. Please see the Contributing Guide for information on how you can help.

Code of Conduct

Everyone interacting in the MkDocs project's codebases, issue trackers, and discussion forums is expected to follow the PyPA Code of Conduct.

License

BSD-2-Clause

Open the repository ↗