mkdocs 1.5.3

Project documentation with Markdown.

Stars: 18196, Watchers: 18196, Forks: 2349, Open Issues: 122

The mkdocs/mkdocs repo was created 10 years ago and the last code push was 14 hours ago.
The project is extremely popular with a mindblowing 18196 github stars!

How to Install mkdocs

You can install mkdocs using pip

pip install mkdocs

or add it to a project with poetry

poetry add mkdocs

Package Details

Author

License

Homepage

PyPi:

https://pypi.org/project/mkdocs/

Documentation:

https://www.mkdocs.org/

GitHub Repo:

https://github.com/mkdocs/mkdocs

Classifiers

• Documentation
• Text Processing

Related Packages

Errors

A list of common mkdocs errors.

Code Examples

Here are some mkdocs code examples and snippets.

GitHub Issues

The mkdocs package has 122 open issues on GitHub

• access theme files from mkdcos-macro
• MkDocs html-escapes quotes in inline-code blocks
• chore: fix relative link
• relative url start with "../" in nav no longer works
• site_url set, but it doesn't use the subdirectory
• Allow users to use a custom edit_uri in markdown frontmatter
• markdown metadata issues (feature vs. memory usage)
• Add page.file to documentation
• Ensure that the edit_uri option does not modify the repo_url
• Defining edit_uri as anything other than an empty string modifies the repo_url
• mkdocs.org has text with a poor contrast
• When envoking mkdocs, it crashes and gives TypeError
• Add "clean_names" option
• SubConfig now catches failures and warnings
• SubConfig ignore configuration failures

See more issues on GitHub