MkDocs

Project documentation with Markdown

PyPI Version Build Status Coverage Status CodSpeed

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-ng while keeping the mkdocs command, 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 while and for, 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

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

BSD-2-Clause

Project links

Data verified by PyPI on Aug 12, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for xpshen from gravatar.com xpshen

Credits

Author: Tom Christie

GitHub Statistics

Data verified by PyPI on Aug 12, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

BSD-2-Clause
View SPDX License List

Requires

Python >=3.10

Provides Extra

i18n min-versions

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_ng-1.8.0.tar.gz (4.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_ng-1.8.0-py3-none-any.whl (5.2 MB view details)

Uploaded Python 3

File details

Details for the file mkdocs_ng-1.8.0.tar.gz.

File metadata

  • Download URL: mkdocs_ng-1.8.0.tar.gz
  • Upload date:
  • Size: 4.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mkdocs_ng-1.8.0.tar.gz
Algorithm Hash digest
SHA256 2e7c6bc108dc5ed81893c17c9776170a38f47b33d6a176a42f7e7bb6360f4d07
MD5 cf5aeaa58199e3c69bb71f9ec2f60dd9
BLAKE2b-256 17f1fd13d631d5f15bdf31a3e1a797723acc1e7e0d7d68aea7a0c92860c39e9d

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_ng-1.8.0.tar.gz:

Publisher: release.yml on mkdocs-ng/mkdocs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mkdocs_ng-1.8.0-py3-none-any.whl.

File metadata

  • Download URL: mkdocs_ng-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 5.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for mkdocs_ng-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6f8e2c76b6e8bff2222a322ee4805f35aa51b0810c41b12f907693b13ab0bad8
MD5 c24aba0c15e6c7db70045cccc28e9bd6
BLAKE2b-256 74a0b18b68c079ea6afa3e1a5ada014f2d3f55227364148eba869d68f26bbfa6

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_ng-1.8.0-py3-none-any.whl:

Publisher: release.yml on mkdocs-ng/mkdocs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.8.0 This release

2 files

1.7.3

2 files

1.7.2

2 files

1.7.1

2 files

1.7.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page