Project documentation with Markdown
MkDocs is afast,simpleanddownright gorgeousstatic 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 theDocumentationfor an introductory tutorial and a full user 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, useDiscussionson GitHub.
- For small questions, a good alternative is theChat roomon Gitter/Matrix.
- To report a bug or make a feature request, open anIssueon 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 arenotbanned from thechat room.
Make sure to stick around to answer some questions as well!
The MkDocs project welcomes, and depends on, contributions from developers and users in the open source community. Please see theContributing Guidefor information on how you can help.
Everyone interacting in the MkDocs project's codebases, issue trackers, and discussion forums is expected to follow thePyPA Code of Conduct.