You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Sean 82bd8ba5ff
Clean up code style (#2825)
2 months ago
.github/workflows Fix PyPy version in MacOS CI workflow (#2755) 5 months ago
docs Clean up code style (#2825) 2 months ago
mkdocs Clean up code style (#2825) 2 months ago
requirements Bump importlib_metadata to at least 4.3 to support Python 3.10 (#2802) 3 months ago
.codecov.yml Update the codecov config 6 years ago
.coveragerc Internal Refactor of Pages, Files, and Navigation (#1504) 4 years ago
.csslintrc Upgrade readthedocs theme to v1.0.0 (#2585) 8 months ago
.editorconfig Add .editorconfig (#1451) 4 years ago
.gitattributes Add .gitattributes file 4 years ago
.gitignore Support theme localization 1 year ago
.jshintignore Upgrade readthedocs theme to v1.0.0 (#2585) 8 months ago
.markdownlintrc Remove line length limit from Markdown documents (#2626) 8 months ago
CONTRIBUTING.md HTTPS Links 4 years ago
LICENSE Update the LICENSE and the README 1 year ago
MANIFEST.in Support theme localization 1 year ago
README.md Update contact instructions: announce chat, preference for issues (#2610) 9 months ago
mkdocs.yml Deprecate google_analytics config option. 1 year ago
readthedocs.yml Add a ReadTheDocs yaml config file 4 years ago
setup.cfg Support theme localization 1 year ago
setup.py Bump importlib_metadata to at least 4.3 to support Python 3.10 (#2802) 3 months ago
tox.ini Clean up code style (#2825) 2 months ago

README.md

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 (new!)
  • 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!

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