Metadata-Version: 2.4
Name: mkdocs-ng
Version: 1.7.2
Summary: Project documentation with Markdown.
Project-URL: Documentation, https://mkdocs-ng.github.io/mkdocs/
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.github.io/mkdocs/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.8
Classifier: Programming Language :: Python :: 3.9
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 :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Documentation
Classifier: Topic :: Text Processing
Requires-Python: >=3.8
Requires-Dist: click>=7.0
Requires-Dist: colorama>=0.4; platform_system == 'Windows'
Requires-Dist: ghp-import>=1.0
Requires-Dist: importlib-metadata>=4.4; python_version < '3.10'
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.1.8; 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: importlib-metadata==4.4; (python_version < '3.10') and extra == 'min-versions'
Requires-Dist: jinja2==3.1.6; extra == 'min-versions'
Requires-Dist: markdown==3.9; extra == 'min-versions'
Requires-Dist: markupsafe==3.0.3; extra == 'min-versions'
Requires-Dist: mkdocs-get-deps==0.2.2; extra == 'min-versions'
Requires-Dist: packaging==26.1; extra == 'min-versions'
Requires-Dist: pathspec==1.0.4; 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'
Description-Content-Type: text/markdown

# MkDocs

> *Project documentation with Markdown*

[![PyPI Version][pypi-v-image]][pypi-v-link]
[![Build Status][GHAction-image]][GHAction-link]
[![Coverage Status][codecov-image]][codecov-link]

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** is a maintained fork of [mkdocs/mkdocs], continued from the
> 1.7.0 line and published on PyPI as `mkdocs-ng`, while preserving the `mkdocs` CLI.
>
> It adds support for Python 3.13 and 3.14, restores `mkdocs serve --livereload`,
> improves strict link and anchor validation, ensures reliable cleanup on `SIGTERM`,
> removes the unmaintained `mergedeep` dependency, and modernizes CI, dependencies,
> release workflows and much [more].
>
> The project is actively maintained and continues to track modern Python,
> packaging, and documentation workflows.

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!

## 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]
- [Catalog of third-party plugins, themes and recipes][catalog]

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

<!-- Badges -->
[codecov-image]: https://codecov.io/github/mkdocs-ng/mkdocs/coverage.svg?branch=main
[codecov-link]: https://codecov.io/github/mkdocs-ng/mkdocs?branch=main
[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs-ng.svg
[pypi-v-link]: https://pypi.org/project/mkdocs-ng/
[GHAction-image]: https://github.com/mkdocs-ng/mkdocs/actions/workflows/ci.yml/badge.svg
[GHAction-link]: https://github.com/mkdocs-ng/mkdocs/actions/workflows/ci.yml
<!-- Links -->
[mkdocs]: https://mkdocs-ng.github.io/mkdocs/
[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.github.io/mkdocs/about/release-notes/
[Contributing Guide]: https://mkdocs-ng.github.io/mkdocs/about/contributing/
[PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/
[catalog]: https://github.com/mkdocs-ng/catalog

## License

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