===== MKDocs =====



=== What it is ===

MkDocs is an open-source **static site generator** that is designed for creating documentation websites.


=== Plugins ===

  * Docu: https://www.mkdocs.org/dev-guide/plugins/
  * Catalog Link: https://github.com/mkdocs/catalog/


Many MkDocs plugins are published on PyPI, which is the official Python package repository. \\
You can search for MkDocs plugins using the "mkdocs" keyword

https://pypi.org/search/?q=mkdocs

== Plugin "blogging" ==

https://pypi.org/project/mkdocs-blogging-plugin/

== Plugin "social" ==

The social plugin automatically and intelligently generates beautiful and highly customizable social cards

https://squidfunk.github.io/mkdocs-material/plugins/social/



=== What it "squidfunk/mkdocs-material" ===

https://github.com/squidfunk/mkdocs-material

Its a framework on top of MKDOCS,
partially commercial.




=== Examples ===

- https://github.com/danvratil/qcoro/blob/main/docs/news/2023/2023-01-31-qcoro-0.8.0-announcement.md?plain=1