Project documentation with Markdown.

These details have not been verified by PyPI

Project links

Project description

MkDocs

Project documentation with Markdown

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!

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

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

This version

1.6.1

Aug 30, 2024

1.6.0

Apr 20, 2024

1.5.3

Sep 18, 2023

1.5.2

Aug 2, 2023

1.5.1

Jul 27, 2023

1.5.0

Jul 26, 2023

1.4.3

May 2, 2023

1.4.2

Nov 1, 2022

1.4.1

Oct 15, 2022

1.4.0

Sep 27, 2022

1.3.1

Jul 19, 2022

1.3.0

Mar 26, 2022

1.2.4

Mar 26, 2022

1.2.3

Oct 12, 2021

1.2.2

Jul 18, 2021

1.2.1

Jun 9, 2021

1.2

Jun 7, 2021

1.1.2

May 14, 2020

1.1.1

May 12, 2020

1.1

Feb 23, 2020

1.0.4

Sep 7, 2018

1.0.3

Aug 29, 2018

1.0.2

Aug 22, 2018

1.0.1

Aug 13, 2018

1.0

Aug 3, 2018

1.0rc1 pre-release

Jul 27, 2018

1.0b1 pre-release

Jul 21, 2018

1.0a1 pre-release

Jul 14, 2018

0.17.5

Jul 6, 2018

0.17.4

Jun 8, 2018

0.17.3

Mar 7, 2018

0.17.2

Nov 15, 2017

0.17.1

Oct 30, 2017

0.17.0

Oct 19, 2017

0.16.3

Apr 4, 2017

0.16.2

Mar 14, 2017

0.16.1

Dec 22, 2016

0.16.0

Nov 4, 2016

0.15.3

Feb 18, 2016

0.15.2

Feb 8, 2016

0.15.1

Jan 30, 2016

0.15.0

Jan 21, 2016

0.14.0

Jun 9, 2015

0.13.3

Jun 2, 2015

0.13.2

May 30, 2015

0.13.1

May 27, 2015

0.13.0

May 26, 2015

0.12.2

Apr 22, 2015

0.12.1

Apr 14, 2015

0.12.0

Apr 14, 2015

0.11.1

Nov 20, 2014

0.11

Nov 18, 2014

0.10

Oct 29, 2014

0.9

Mar 31, 2014

0.8

Mar 31, 2014

0.7

Mar 31, 2014

0.6

Mar 31, 2014

0.5

Feb 26, 2014

0.4

Feb 12, 2014

0.3

Feb 1, 2014

0.2

Jan 21, 2014

0.1

Jan 11, 2014

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 details)

Uploaded Aug 30, 2024 Source

Built Distribution

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

Uploaded Aug 30, 2024 Python 3

File details

Details for the file mkdocs-1.6.1.tar.gz.

File metadata

Download URL: mkdocs-1.6.1.tar.gz
Upload date: Aug 30, 2024
Size: 3.9 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for mkdocs-1.6.1.tar.gz
Algorithm	Hash digest
SHA256	`7b432f01d928c084353ab39c57282f29f92136665bdd6abf7c1ec8d822ef86f2`
MD5	`aad5d11eaa821d4edde85ad429a96f05`
BLAKE2b-256	`bcc6bbd4f061bd16b378247f12953ffcb04786a618ce5e904b8c5a01a0309061`

See more details on using hashes here.

Provenance

File details

Details for the file mkdocs-1.6.1-py3-none-any.whl.

File metadata

Download URL: mkdocs-1.6.1-py3-none-any.whl
Upload date: Aug 30, 2024
Size: 3.9 MB
Tags: Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for mkdocs-1.6.1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`db91759624d1647f3f34aa0c3f327dd2601beae39a366d6e064c03468d35c20e`
MD5	`1be8948ff4d3b56acb477961f6483410`
BLAKE2b-256	`225bdbc6a8cddc9cfa9c4971d59fb12bb8d42e161b7e7f8cc89e49137c5b279c`