Repository files navigation

Project documentation with Markdown

MkDocs is afast,simple anddownright gorgeous static sitegenerator that's geared towards building project documentation. Documentationsource files are written in Markdown, and configured with a single YAMLconfiguration file. It is designed to be easy to use and can be extended withthird-party themes, plugins, and Markdown extensions.

Please see theDocumentation for an introductory tutorial and a fulluser guide.

• 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!

If you need help with MkDocs, do not hesitate to get in contact with us!

• For questions and high-level discussions, useDiscussions on GitHub.
  • For small questions, a good alternative is theChat room onGitter/Matrix.
• To report a bug or make a feature request, open anIssue on GitHub.

Please note that we may only providesupport for problems/questions regarding core features of MkDocs. Anyquestions or bug reports about features of third-party themes, plugins,extensions or similar should be made to their respective projects.
But, such questions arenot banned from thechat room.

Make sure to stick around to answer some questions as well!

• Official Documentation
• Latest Release Notes
• Catalog of third-party plugins, themes and recipes

The MkDocs project welcomes, and depends on, contributions from developers andusers in the open source community. Please see theContributing Guide forinformation on how you can help.

Everyone interacting in the MkDocs project's codebases, issue trackers, anddiscussion forums is expected to follow thePyPA Code of Conduct.

BSD-2-Clause