Metadata-Version: 2.5
Name: mkdocs-ng
Version: 1.11.1
Summary: Write Markdown. Ship docs. The maintained MkDocs that keeps your plugins working.
Project-URL: Documentation, https://mkdocs-ng.org/
Project-URL: Source, https://github.com/mkdocs-ng/mkdocs
Project-URL: Issues, https://github.com/mkdocs-ng/mkdocs/issues
Project-URL: Discussions, https://github.com/orgs/mkdocs-ng/discussions
Project-URL: History, https://mkdocs-ng.org/about/release-notes/
Author-email: Tom Christie <tom@tomchristie.com>, Xianpeng Shen <xianpeng.shen@gmail.com>
License-Expression: BSD-2-Clause
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Documentation
Classifier: Topic :: Text Processing
Requires-Python: >=3.10
Requires-Dist: click>=8.1.8
Requires-Dist: colorama>=0.4; platform_system == 'Windows'
Requires-Dist: ghp-import>=1.0
Requires-Dist: jinja2>=2.11.1
Requires-Dist: markdown>=3.3.6
Requires-Dist: markupsafe>=2.0.1
Requires-Dist: mkdocs-get-deps>=0.2.0
Requires-Dist: packaging>=20.5
Requires-Dist: pathspec>=0.11.1
Requires-Dist: pyyaml-env-tag>=0.1
Requires-Dist: pyyaml>=5.1
Requires-Dist: watchdog>=2.0
Provides-Extra: i18n
Requires-Dist: babel>=2.9.0; extra == 'i18n'
Provides-Extra: min-versions
Requires-Dist: babel==2.18.0; extra == 'min-versions'
Requires-Dist: click==8.5.0; extra == 'min-versions'
Requires-Dist: colorama==0.4.6; (platform_system == 'Windows') and extra == 'min-versions'
Requires-Dist: ghp-import==2.1.0; extra == 'min-versions'
Requires-Dist: jinja2==3.1.6; extra == 'min-versions'
Requires-Dist: markdown==3.10.3; extra == 'min-versions'
Requires-Dist: markupsafe==3.0.4; extra == 'min-versions'
Requires-Dist: mkdocs-get-deps==0.2.2; extra == 'min-versions'
Requires-Dist: packaging==26.3; extra == 'min-versions'
Requires-Dist: pathspec==1.1.1; extra == 'min-versions'
Requires-Dist: pyyaml-env-tag==1.1; extra == 'min-versions'
Requires-Dist: pyyaml==6.0.3; extra == 'min-versions'
Requires-Dist: watchdog==6.0.0; extra == 'min-versions'
Provides-Extra: sumi
Requires-Dist: mkdocs-sumi>=0.1.2; extra == 'sumi'
Description-Content-Type: text/markdown

<p align="center">
  <a href="https://mkdocs-ng.org/">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/mkdocs-ng/mkdocs/main/docs/img/logo-dark.svg">
      <img src="https://raw.githubusercontent.com/mkdocs-ng/mkdocs/main/docs/img/logo.svg" width="160" alt="MkDocs NG">
    </picture>
  </a>
</p>

<h1 align="center">MkDocs NG</h1>

<p align="center">
  <strong>Write Markdown. Ship docs.</strong>
  <br>
  The maintained MkDocs that keeps your plugins working.
</p>

<p align="center">
  <a href="https://pypi.org/project/mkdocs-ng/"><img src="https://img.shields.io/pypi/v/mkdocs-ng.svg" alt="PyPI version"></a>
  <a href="https://pypi.org/project/mkdocs-ng/"><img src="https://img.shields.io/pypi/pyversions/mkdocs-ng.svg" alt="Python versions"></a>
  <a href="https://github.com/mkdocs-ng/mkdocs/actions/workflows/ci.yml"><img src="https://github.com/mkdocs-ng/mkdocs/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
  <a href="https://mkdocs-ng.org/user-guide/migrating/#plugins-and-themes"><img src="https://img.shields.io/github/actions/workflow/status/mkdocs-ng/mkdocs/compat.yml?branch=main&label=plugin%20compatibility" alt="Plugin compatibility"></a>
  <a href="https://codecov.io/github/mkdocs-ng/mkdocs?branch=main"><img src="https://codecov.io/github/mkdocs-ng/mkdocs/coverage.svg?branch=main" alt="Coverage"></a>
  <a href="https://app.codspeed.io/mkdocs-ng/mkdocs?utm_source=badge"><img src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" alt="CodSpeed"></a>
  <a href="https://github.com/mkdocs-ng/mkdocs/blob/main/LICENSE"><img src="https://img.shields.io/pypi/l/mkdocs-ng.svg" alt="License"></a>
</p>

<p align="center">
  <a href="https://mkdocs-ng.org/">Documentation</a> ·
  <a href="https://mkdocs-ng.org/user-guide/migrating/">Switching from MkDocs</a> ·
  <a href="https://mkdocs-ng.org/about/release-notes/">Release notes</a> ·
  <a href="https://github.com/mkdocs-ng/catalog">Plugin catalog</a>
</p>

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.

<p align="center">
  <a href="https://mkdocs-ng.org/about/comparison/#build-speed">
    <picture>
      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/mkdocs-ng/mkdocs/main/docs/img/build-speed-dark.svg">
      <img src="https://raw.githubusercontent.com/mkdocs-ng/mkdocs/main/docs/img/build-speed.svg" width="720" alt="Clean build of a 1,000-page site: MkDocs NG with Material 11.1 s, Zensical 15.9 s, Sphinx with 4 processes 23.5 s, ProperDocs with Material 32.1 s, Starlight 32.9 s, MkDocs 1.6.1 with Material 34.2 s, VitePress 85.4 s, Docusaurus 106.6 s">
    </picture>
  </a>
</p>

<p align="center">
  <i>Clean build of the same 1,000-page site. Zensical is faster when it reuses its cache and when <code>serve</code> shows an edit.
  <br>
  <a href="https://mkdocs-ng.org/about/comparison/#build-speed">How we measured</a></i>
</p>

> [!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.15 support,
> built-in `llms.txt` and per-page Markdown output for LLMs and coding agents,
> 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][fixed-upstream] and the [release notes][release-notes],
> or browse [all merged changes][more].

Please see the [Documentation][mkdocs] 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:

```bash
pip install mkdocs-ng
```

Switching from `mkdocs`? Just install MkDocs NG — the command, imports and
configuration stay exactly the same:

```bash
pip install -U mkdocs-ng
```

Plugins and themes depend on the `mkdocs` package, so upstream MkDocs gets
installed alongside. That's fine: MkDocs NG installs its files separately and
always takes precedence, so leave the upstream package installed. See
[Plugins, themes and the `mkdocs` package][plugins-install] for details, and
[Switching to MkDocs NG][migrating] for what behaves differently from upstream
MkDocs.

## 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][mkdocs]
- [Latest Release Notes][release-notes]
- [Fixed Upstream Issues][fixed-upstream]
- [Switching to MkDocs NG][migrating]
- [Comparison with upstream MkDocs 2.0, ProperDocs and Zensical][comparison]
- [Catalog of third-party plugins, themes and recipes][catalog]
- [Sumi][sumi], a local-first documentation theme from the MkDocs NG project
- [MkDocs NG Material][ng-material], Material for MkDocs maintained for MkDocs NG

## 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].

<!-- Links -->
[mkdocs]: https://mkdocs-ng.org/
[mkdocs/mkdocs]: https://github.com/mkdocs/mkdocs
[more]: https://github.com/mkdocs-ng/mkdocs/pulls?page=1&q=is%3Apr+is%3Aclosed+is%3Amerged
[Issue]: https://github.com/mkdocs-ng/mkdocs/issues
[Discussions]: https://github.com/orgs/mkdocs-ng/discussions
[release-notes]: https://mkdocs-ng.org/about/release-notes/
[fixed-upstream]: https://mkdocs-ng.org/about/fixed-upstream-issues/
[plugins-install]: https://mkdocs-ng.org/user-guide/installation/#plugins-themes-and-the-mkdocs-package
[migrating]: https://mkdocs-ng.org/user-guide/migrating/
[comparison]: https://mkdocs-ng.org/about/comparison/
[Contributing Guide]: https://mkdocs-ng.org/about/contributing/
[PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/
[catalog]: https://github.com/mkdocs-ng/catalog
[sumi]: https://github.com/mkdocs-ng/mkdocs-sumi
[ng-material]: https://github.com/mkdocs-ng/mkdocs-material

## License

[BSD-2-Clause](https://github.com/mkdocs-ng/mkdocs/blob/main/LICENSE)
