mkdocs

Project documentation with Markdown.

13815
1972
Python

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