Contents

mkdocs 1.6.1

0

Project documentation with Markdown.

Project documentation with Markdown.

Stars: 21732, Watchers: 21732, Forks: 2592, Open Issues: 144

The mkdocs/mkdocs repo was created 12 years ago and the last code push was 4 months ago.
The project is extremely popular with a mindblowing 21732 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
None
License
None
Homepage
None
PyPi:
https://pypi.org/project/mkdocs/
Documentation:
https://www.mkdocs.org/
GitHub Repo:
https://github.com/mkdocs/mkdocs

Classifiers

  • Documentation
  • Text Processing
No  mkdocs  pypi packages just yet.

Errors

A list of common mkdocs errors.

Code Examples

Here are some mkdocs code examples and snippets.

GitHub Issues

The mkdocs package has 144 open issues on GitHub

  • Got unexpected ouput while use nest List
  • Code blocks colors not working at all
  • Update getting-started.md
  • docs: add example of using a different port for mkdocs serve
  • fix merge strategy for INHERIT configuration
  • In a mixed list, lack of indentation leads to combining of the lists
  • Live reload does not trigger automatically unless '–livereload' is explicitly passed
  • mkdocs does not watch for file changes when using click>8.2.1
  • mkdocs serve not loading external images
  • Fix issue with handling </>

See more issues on GitHub

Related Packages & Articles

mistune 3.2.0

A sane and fast Markdown parser with useful plugins and renderers

mdutils 1.8.1

Useful package for creating Markdown files while executing python code.

m2r 0.3.1

Markdown and reStructuredText in a single file.