MkDocs
Project documentation with Markdown
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.
[!NOTE] MkDocs NG is a maintained fork of mkdocs/mkdocs, published on PyPI as
mkdocs-ngwhile keeping themkdocscommand, imports and configuration unchanged — a drop-in replacement.Highlights beyond the last upstream release: Python 3.10–3.14 support, search that finds programming keywords like
whileandfor, faster builds with smaller site output, a stable Python API (mkdocs.build()/mkdocs.serve()), fully offline syntax highlighting with no CDNs or analytics, and many long-standing bug fixes — see Fixed Upstream Issues and the release notes, or browse all merged changes.
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!
Installation
Install with pip:
pip install mkdocs-ng
Switching from mkdocs? Uninstall it first — the command, imports and
configuration stay exactly the same:
pip uninstall mkdocs && pip install -U mkdocs-ng
Support
If you need help with MkDocs:
- Use Discussions for questions and general help.
- To report a bug or make a feature request, open an Issue on GitHub.
We may only provide support for core MkDocs features. Questions about third-party themes, plugins, or extensions should usually go to those projects first, but they are still welcome in Discussions.
Links
- Official Documentation
- Latest Release Notes
- Fixed Upstream Issues
- Catalog of third-party plugins, themes and recipes
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 are expected to follow the PyPA Code of Conduct.
License
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-ng 1.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| mkdocs_ng-1.8.0.tar.gz | 4.7 MB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_ng-1.8.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 9.9 MB
Release files / mkdocs_ng-1.8.0.tar.gz
| Download URL | mkdocs_ng-1.8.0.tar.gz |
|---|---|
| Size | 4.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2e7c6bc108dc5ed81893c17c9776170a38f47b33d6a176a42f7e7bb6360f4d07
|
|
BLAKE2b-256 checksum How to use checksums |
17f1fd13d631d5f15bdf31a3e1a797723acc1e7e0d7d68aea7a0c92860c39e9d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 12, 2026.
Transparency logRelease files / mkdocs_ng-1.8.0-py3-none-any.whl
| Download URL | mkdocs_ng-1.8.0-py3-none-any.whl |
|---|---|
| Size | 5.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6f8e2c76b6e8bff2222a322ee4805f35aa51b0810c41b12f907693b13ab0bad8
|
|
BLAKE2b-256 checksum How to use checksums |
74a0b18b68c079ea6afa3e1a5ada014f2d3f55227364148eba869d68f26bbfa6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 12, 2026.
Transparency logSecurity for mkdocs-ng 1.8.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for mkdocs_ng-1.8.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 12, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
