Popularity
9.4
Stable
Activity
8.4
Growing
12,983
231
1,846

Code Quality Rank: L5
Programming language: Python
License: BSD 3-clause "New" or "Revised" License
Latest version: v1.1.2

MkDocs alternatives and similar packages

Based on the "Documentation" category.
Alternatively, view MkDocs alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of MkDocs or a related project?

Add another 'Documentation' Package

README

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!

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.

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.

<!-- Badges -->

<!-- Links -->

License

BSD-2-Clause


*Note that all licence references and agreements mentioned in the MkDocs README section above are relevant to that project's source code only.