Skip to main content

Project documentation with Markdown.

Project description


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.


  • Build static HTML files from Markdown files.
  • Use Plugins and Markdown Extensions to enhance MkDocs.
  • Use the build-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!

You can either open a Discussion to ask questions or create an Issue to report a bug or make a feature request. 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.


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.



Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mkdocs, version 1.2.2
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs-1.2.2-py3-none-any.whl (6.4 MB) File type Wheel Python version py3 Upload date Hashes View
Filename, size mkdocs-1.2.2.tar.gz (6.3 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page