User Tools

Site Tools


mkdocs

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
mkdocs [2023/10/20 07:34] – created skipidarmkdocs [2023/10/20 08:02] (current) skipidar
Line 1: Line 1:
 ===== MKDocs ===== ===== MKDocs =====
  
-  * Docu: https://www.mkdocs.org/dev-guide/plugins/ 
-  * Catalog Link: https://github.com/mkdocs/catalog/ 
  
  
Line 8: Line 6:
  
 MkDocs is an open-source **static site generator** that is designed for creating documentation websites. 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" === === What it "squidfunk/mkdocs-material" ===
Line 15: Line 37:
 Its a framework on top of MKDOCS, Its a framework on top of MKDOCS,
 partially commercial. partially commercial.
 +
 +
 +
 +
 +=== Examples ===
 +
 +- https://github.com/danvratil/qcoro/blob/main/docs/news/2023/2023-01-31-qcoro-0.8.0-announcement.md?plain=1
mkdocs.1697787249.txt.gz · Last modified: by skipidar