MkDocs is a Python-based static site generatorthat combines Markdown content with Jinja2 templates toproduce websites. MkDocs can be pronounced 'McDocs' or 'M-K Docs',although the core committers do not have a strong preferenceone way or the other on the name's pronunciation.
MkDocs'source code is available on GitHubunder theBSD 2-clause license.
What's great about MkDocs?
Egg MANIFEST # PyInstaller # Usually these files are written by a python script from a template #. Ropeproject # mkdocs documentation /site # mypy. Create a branded static site from a set of Markdown files to host the documentation of your Open Source or commercial project – customizable, searchable, mobile-friendly, 40+ languages.
MkDocs uses a YAML configuration file and can optionally use themes toeasy change the look-and-feel of the documentation output.
In addition to the easy configuration via a YAML file and the drop-inthemes, MkDocs also has a wonderful search feature. Search is often notpossible out of the box in other static site generators. With MkDocs searchcan easily be added without plugins or code changes to the static sitegenerator.
MkDocs resources
The officialGetting Started with MkDocsis likely the best place to go when you are just getting set up with yourfirst site that uses this project.
Mkdocs documentation is a quicktutorial to get MkDocs installed and modify the initial mkdocs.yml file.
MkDocs making stridesis a post from one of the project's core commiters on some changes thatgreatly improved the project such as site regeneration during developmentwhen a file is modified, search, the command-line client and packageabletheming.
What do you need to learn about static site generators?
Mkdocs Vs Sphinx
Mkdocs To Pdf
I want to learn how to code a Python web application using a framework.
Mkdocs Examples
I've built a Python web app, now how do I deploy it?