Project documentation with Markdown.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for d0ugal from gravatar.com d0ugal Avatar for mkdocsdeploy from gravatar.com mkdocsdeploy Avatar for oprypin from gravatar.com oprypin Avatar for tomchristie from gravatar.com tomchristie Avatar for waylan from gravatar.com waylan

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License
  • Author: Tom Christie
  • Requires: Python >=3.8
  • Provides-Extra: i18n, min-versions
Classifiers

Project description

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

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.

License

BSD-2-Clause

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for d0ugal from gravatar.com d0ugal Avatar for mkdocsdeploy from gravatar.com mkdocsdeploy Avatar for oprypin from gravatar.com oprypin Avatar for tomchristie from gravatar.com tomchristie Avatar for waylan from gravatar.com waylan

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License
  • Author: Tom Christie
  • Requires: Python >=3.8
  • Provides-Extra: i18n, min-versions
Classifiers

Release history Release notifications | RSS feed

This version

1.6.1

1.6.0

1.5.3

1.5.2

1.5.1

1.5.0

1.4.3

1.4.2

1.4.1

1.4.0

1.3.1

1.3.0

1.2.4

1.2.3

1.2.2

1.2.1

1.2

1.1.2

1.1.1

1.1

1.0.4

1.0.3

1.0.2

1.0.1

1.0

1.0rc1 pre-release

1.0b1 pre-release

1.0a1 pre-release

0.17.5

0.17.4

0.17.3

0.17.2

0.17.1

0.17.0

0.16.3

0.16.2

0.16.1

0.16.0

0.15.3

0.15.2

0.15.1

0.15.0

0.14.0

0.13.3

0.13.2

0.13.1

0.13.0

0.12.2

0.12.1

0.12.0

0.11.1

0.11

0.10

0.9

0.8

0.7

0.6

0.5

0.4

0.3

0.2

0.1

Download files

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

Source Distribution

mkdocs-1.6.1.tar.gz (3.9 MB view hashes)

Uploaded Source

Built Distribution

mkdocs-1.6.1-py3-none-any.whl (3.9 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page