Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkdocs/catalog
:trophy: :books: A list of awesome MkDocs projects and plugins.
https://github.com/mkdocs/catalog
best-of best-of-list mkdocs
Last synced: 2 days ago
JSON representation
:trophy: :books: A list of awesome MkDocs projects and plugins.
- Host: GitHub
- URL: https://github.com/mkdocs/catalog
- Owner: mkdocs
- License: cc-by-sa-4.0
- Created: 2022-04-17T07:48:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-26T19:02:21.000Z (16 days ago)
- Last Synced: 2025-01-02T18:07:00.231Z (9 days ago)
- Topics: best-of, best-of-list, mkdocs
- Language: Python
- Homepage:
- Size: 4.4 MB
- Stars: 1,164
- Watchers: 15
- Forks: 72
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: history/2022-04-17_changes.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- my-awesome-github-stars - mkdocs/catalog - :trophy: :books: A list of awesome MkDocs projects and plugins. (Python)
- jimsghstars - mkdocs/catalog - :trophy: :books: A list of awesome MkDocs projects and plugins. (Python)
README
catalog
:trophy: :books: A list of awesome MkDocs projects and plugins.
This list contains 280 awesome open-source projects grouped into 17 categories. All projects are ranked by a project-quality score, which is calculated based on various metrics automatically collected from GitHub and different package managers. If you want to add or update projects, feel free to open an [issue](https://github.com/mkdocs/catalog/issues/new/choose), submit a [pull request](https://github.com/mkdocs/catalog/pulls), or directly edit the [projects.yaml](https://github.com/mkdocs/catalog/edit/main/projects.yaml). Contributions are very welcome!
> 🧙♂️ Discover other [best-of lists](https://best-of.org) or [create your own](https://github.com/best-of-lists/best-of/blob/main/create-best-of-list.md).
## Contents
- [🎨 Theming](#-theming) _30 projects_
- [💻 API documentation building](#-api-documentation-building) _19 projects_
- [💬 Blogging](#-blogging) _7 projects_
- [📊 Charts, Images, Tables & Graphs](#-charts-images-tables--graphs) _37 projects_
- [🤖 Code execution, variables & templating](#-code-execution-variables--templating) _20 projects_
- [🌲 Git repos & info](#-git-repos--info) _10 projects_
- [🌈 HTML processing & CSS styling](#-html-processing--css-styling) _15 projects_
- [📎 Integrations with other tools](#-integrations-with-other-tools) _10 projects_
- [🌍 Internationalization & localization](#-internationalization--localization) _3 projects_
- [🔗 Links & references](#-links--references) _24 projects_
- [🧩 Markdown extensions](#-markdown-extensions) _28 projects_
- [🧭 Navigation & page building](#-navigation--page-building) _27 projects_
- [✅ Quality checks (code blocks, spelling, etc.)](#-quality-checks-code-blocks-spelling-etc) _6 projects_
- [🔍 Search & tables of content](#-search--tables-of-content) _5 projects_
- [🍱 Site conversion (PDF/ePUB/etc.)](#-site-conversion-pdfepubetc) _11 projects_
- [🔧 Site building, site management](#-site-building-site-management) _21 projects_
- [📁 Snippets & includes (reusing contents)](#-snippets--includes-reusing-contents) _9 projects_
## Explanation
- 🥇🥈🥉 Combined project-quality score
- ⭐️ Star count from GitHub
- 🐣 New project _(less than 6 months old)_
- 💤 Inactive project _(12 months no activity)_
- 💀 Dead project _(99999 months no activity)_
- 📈📉 Project is trending up or down
- ➕ Project was recently added
- ❗️ Warning _(e.g. missing/risky license)_
- 👨💻 Contributors count from GitHub
- 🔀 Fork count from GitHub
- 📋 Issue count from GitHub
- ⏱️ Last update timestamp on package manager
- 📥 Download count from package manager
- 📦 Number of dependent projects
- 
MkDocs plugin
- 
MkDocs theme
- 
Mkdocs-based project (website, templates, etc.)
- 
Markdown extension(s)
## 🎨 Theming
Material for MkDocs - 🥇42 · ⭐ 22K · MIT ·
Documentation that simply works.
- [GitHub](https://github.com/squidfunk/mkdocs-material) (👨💻 300 · 🔀 3.5K · 📦 58K · 📋 2.5K - 0% open · ⏱️ 31.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-material) (📥 5M / month):
```
pip install mkdocs-material
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: material
```
Extras:
```yaml
plugins:
- blog
- group
- offline
- search
- social
- tags
```
Cinder - 🥇22 · ⭐ 210 · 💤 · MIT ·
A clean, responsive MkDocs theme.
- [GitHub](https://github.com/chrissimpkins/cinder) (👨💻 23 · 🔀 100 · 📥 1K · 📦 660 · 📋 51 - 31% open · ⏱️ 05.01.2021)
- [PyPi](https://pypi.org/project/mkdocs-cinder) (📥 6K / month):
```
pip install mkdocs-cinder
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: cinder
```
Bootswatch - 🥇19 · ⭐ 150 · 💤 · BSD-2 ·
MkDocs Bootswatch Themes.
- [GitHub](https://github.com/mkdocs/mkdocs-bootswatch) (👨💻 10 · 🔀 58 · 📦 1.2K · 📋 33 - 9% open · ⏱️ 29.12.2023)
- [PyPi](https://pypi.org/project/mkdocs-bootswatch) (📥 12K / month):
```
pip install mkdocs-bootswatch
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: cerulean
theme: cosmo
theme: cyborg
theme: darkly
theme: flatly
theme: journal
theme: litera
theme: lumen
theme: lux
theme: materia
theme: minty
theme: pulse
theme: sandstone
theme: simplex
theme: slate
theme: solar
theme: spacelab
theme: superhero
theme: united
theme: yeti
```
Terminal for MkDocs - 🥇19 · ⭐ 140 · MIT ·
monospace theme for MkDocs.
- [GitHub](https://github.com/ntno/mkdocs-terminal) (👨💻 3 · 🔀 8 · 📦 98 · 📋 66 - 42% open · ⏱️ 24.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-terminal) (📥 3.6K / month):
```
pip install mkdocs-terminal
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: terminal
```
Extras:
```yaml
plugins:
- md-to-html
```
Simple Blog - 🥈18 · ⭐ 86 · MIT ·
Blog Template for Mkdocs.
- [GitHub](https://github.com/FernandoCelmer/mkdocs-simple-blog) (👨💻 3 · 🔀 5 · 📦 80 · 📋 21 - 47% open · ⏱️ 27.10.2024)
- [PyPi](https://pypi.org/project/mkdocs-simple-blog) (📥 1.3K / month):
```
pip install mkdocs-simple-blog
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: simple-blog
```
Bootstrap - 🥈17 · ⭐ 86 · 💤 · BSD-2 ·
MkDocs Bootstrap Theme.
- [GitHub](https://github.com/mkdocs/mkdocs-bootstrap) (👨💻 6 · 🔀 35 · 📦 480 · 📋 16 - 6% open · ⏱️ 29.12.2023)
- [PyPi](https://pypi.org/project/mkdocs-bootstrap) (📥 11K / month):
```
pip install mkdocs-bootstrap
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: bootstrap
```
Dracula - 🥈17 · ⭐ 83 · MIT ·
Dark theme for Mkdocs.
- [GitHub](https://github.com/dracula/mkdocs) (👨💻 4 · 🔀 11 · 📦 110 · 📋 14 - 7% open · ⏱️ 17.01.2024)
- [PyPi](https://pypi.org/project/mkdocs-dracula-theme) (📥 1.8K / month):
```
pip install mkdocs-dracula-theme
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: dracula
```
Windmill - 🥈16 · ⭐ 110 · 💤 · MIT ·
Outstanding mkdocs theme with a focus on navigation and usability.
- [GitHub](https://github.com/gristlabs/mkdocs-windmill) (👨💻 8 · 🔀 47 · 📦 320 · 📋 31 - 48% open · ⏱️ 11.03.2022)
- [PyPi](https://pypi.org/project/mkdocs-windmill) (📥 2.5K / month):
```
pip install mkdocs-windmill
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: windmill
```
Lantana - 🥈16 · ⭐ 14 · MIT ·
Lantana MKDocsHTML.
- [GitHub](https://github.com/WSOFT-Project/lantana) (👨💻 3 · 📥 420 · 📦 6 · 📋 20 - 5% open · ⏱️ 16.12.2024)
- [PyPi](https://pypi.org/project/lantana) (📥 2.5K / month):
```
pip install lantana
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: lantana
```
mkdocs-curriculum-vitae - 🥈13 · ⭐ 2 · 🐣 · MIT ·
A simple MkDocs theme, designed to make your curriculum vitae (CV) with minimal configuration, and several themes.
- [GitHub](https://github.com/Paul-Riviere/mkdocs-curriculum-vitae) (👨💻 3 · 🔀 1 · 📦 2 · 📋 35 - 25% open · ⏱️ 04.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-curriculum-vitae) (📥 1.3K / month):
```
pip install mkdocs-curriculum-vitae
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: curriculum-vitae
```
Torillic - 🥈12 · ⭐ 100 · ❗️CC0-1.0 ·
A D&D inspired theme for styling TTRPG notes and resources.
- [GitHub](https://github.com/TEParsons/torillic) (👨💻 4 · 🔀 90 · 📥 7.6K · ⏱️ 05.09.2024)
- [PyPi](https://pypi.org/project/mkdocs-torillic) (📥 510 / month):
```
pip install mkdocs-torillic
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: torillic
```
Zettelkasten - 🥈12 · ⭐ 16 · MIT ·
This is a Zettelkasten theme and plugin for MkDocs. It renders the MkDocs pages as cards (zettels).
- [GitHub](https://github.com/buvis/mkdocs-zettelkasten) (👨💻 3 · 🔀 3 · 📥 30 · 📦 6 · 📋 11 - 72% open · ⏱️ 26.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-zettelkasten) (📥 310 / month):
```
pip install mkdocs-zettelkasten
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: zettelkasten-solarized-light
```
Extras:
```yaml
plugins:
- zettelkasten
```
SWAN - 🥈12 · ⭐ 7 · ❗️AGPL-3.0 ·
SWAN MkDocs theme.
- [GitHub](https://github.com/swan-cern/mkdocs-swan) (👨💻 4 · 🔀 3 · 📦 10 · ⏱️ 23.01.2024)
- [PyPi](https://pypi.org/project/mkdocs-swan) (📥 280 / month):
```
pip install mkdocs-swan
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: swan
```
Ivory - 🥉11 · ⭐ 10 · 💤 · MIT ·
Ivory theme for MkDocs.
- [GitHub](https://github.com/daizutabi/mkdocs-ivory) (👨💻 2 · 🔀 4 · 📦 91 · 📋 6 - 50% open · ⏱️ 16.06.2020)
- [PyPi](https://pypi.org/project/mkdocs-ivory) (📥 1.7K / month):
```
pip install mkdocs-ivory
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: ivory
```
KPN for MkDocs - 🥉11 · ⭐ 8 · MIT ·
KPN theme for MkDocs | owner=flow.
- [GitHub](https://github.com/kpn/mkdocs-kpn-theme) (👨💻 3 · 📦 5 · ⏱️ 31.01.2024)
- [PyPi](https://pypi.org/project/mkdocs-kpn) (📥 1.7K / month):
```
pip install mkdocs-kpn
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: kpn
```
Landing - 🥉10 · ⭐ 7 · 🐣 · ❗️CC0-1.0 ·
An mkdocs theme geared towards making a personal landing page, with simpler navigation and heavily customisable style..
- [GitHub](https://github.com/TEParsons/mkdocs-landing) (👨💻 4 · 🔀 1 · 📥 3 · 📦 1 · ⏱️ 30.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-landing) (📥 1.1K / month):
```
pip install mkdocs-landing
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: landing
```
Bootstrap 4 - 🥉10 · ⭐ 6 · MIT ·
A vanilla Bootstrap 4 theme for MkDocs.
- [GitHub](https://github.com/LukeCarrier/mkdocs-theme-bootstrap4) (👨💻 3 · 📦 8 · 📋 6 - 16% open · ⏱️ 23.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-theme-bootstrap4) (📥 250 / month):
```
pip install mkdocs-theme-bootstrap4
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: bootstrap4
```
Extras:
```yaml
plugins:
- bootstrap4-blockquotes
- bootstrap4-tables
```
CustomMill - 🥉9 · ⭐ 12 · 💤 · ❗Unlicensed ·
Outstanding mkdocs theme with a focus on navigation, customization and usability.
- [GitHub](https://github.com/Siphalor/mkdocs-custommill) (👨💻 8 · 🔀 6 · 📦 21 · ⏱️ 10.03.2022)
- [PyPi](https://pypi.org/project/mkdocs-custommill) (📥 550 / month):
```
pip install mkdocs-custommill
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: custommill
```
Alabaster - 🥉8 · ⭐ 36 · 💤 · ❗Unlicensed ·
Alabaster port for MkDocs.
- [GitHub](https://github.com/notpushkin/mkdocs-alabaster) (👨💻 9 · 🔀 10 · 📋 17 - 17% open · ⏱️ 16.06.2020)
- [PyPi](https://pypi.org/project/mkdocs-alabaster) (📥 820 / month):
```
pip install mkdocs-alabaster
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: alabaster
```
Windmill Dark - 🥉8 · ⭐ 33 · 💤 · ❗Unlicensed ·
Outstanding mkdocs theme with a focus on navigation and usability.
- [GitHub](https://github.com/noraj/mkdocs-windmill-dark) (👨💻 4 · 🔀 10 · ⏱️ 12.05.2022)
- [PyPi](https://pypi.org/project/mkdocs-windmill-dark) (📥 520 / month):
```
pip install mkdocs-windmill-dark
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: windmill-dark
```
GitBook - 🥉8 · ⭐ 28 · 💤 · ❗Unlicensed ·
Default theme for GitBook for Mkdocs https://lramage.gitlab.io/mkdocs-gitbook-theme.
- [PyPi](https://pypi.org/project/mkdocs-gitbook) (📥 10K / month):
```
pip install mkdocs-gitbook
```
- [GitLab](https://gitlab.com/lramage/mkdocs-gitbook-theme) (🔀 13 · 📋 19 - 47% open · ⏱️ 17.12.2018)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: gitbook
```
Risonia - 🥉8 · ⭐ 4 · 💤 · ❗Unlicensed ·
A simple theme for MkDocs, using the w3.css framework and configurable color schemes.
- [GitHub](https://github.com/unverbuggt/mkdocs-risonia-theme) (🔀 1 · 📦 4 · ⏱️ 01.09.2023)
- [PyPi](https://pypi.org/project/mkdocs-risonia-theme) (📥 300 / month):
```
pip install mkdocs-risonia-theme
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: risonia
```
Extras:
```yaml
plugins:
- color-theme
- w3css-classes
```
BOOTSTRAP386 - 🥉7 · ⭐ 33 · 💤 · ❗Unlicensed ·
A vintage 1980s DOS inspired Twitter Bootstrap theme for MkDocs https://lramage.gitlab.io/mkdocs-bootstrap386.
- [PyPi](https://pypi.org/project/mkdocs-bootstrap386) (📥 4.1K / month):
```
pip install mkdocs-bootstrap386
```
- [GitLab](https://gitlab.com/lramage/mkdocs-bootstrap386) (🔀 3 · 📋 7 - 57% open · ⏱️ 06.06.2018)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: bootstrap386
```
Moonstone - 🥉7 · ⭐ 7 · 💤 · ❗Unlicensed ·
A documentation theme for mkdocs.
- [GitHub](https://github.com/byrnereese/mkdocs-moonstone) (🔀 1 · 📦 12 · ⏱️ 15.06.2021)
- [PyPi](https://pypi.org/project/mkdocs-moonstone) (📥 1.1K / month):
```
pip install mkdocs-moonstone
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: moonstone
```
Nature - 🥉7 · ⭐ 5 · 💤 · ❗Unlicensed ·
A MkDocs theme.
- [GitHub](https://github.com/waylan/mkdocs-nature) (👨💻 2 · 🔀 1 · 📦 44 · ⏱️ 14.09.2023)
- [PyPi](https://pypi.org/project/mkdocs-nature) (📥 990 / month):
```
pip install mkdocs-nature
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: nature
```
docSkimmer - 🥉6 · ⭐ 18 · 💤 · ❗Unlicensed ·
An accessible, skimmable theme for MkDocs.
- [GitHub](https://github.com/hfagerlund/mkdocs-docskimmer) (⏱️ 05.11.2023)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: docskimmer
```
mkdocs-theme-topdf - 🥉6 · ⭐ 13 · 💤 · MPL-2.0 ·
A mkdocs theme for create PDF and printing with paged.js.
- [GitHub](https://github.com/kuri65536/mkdocs-theme-topdf) (🔀 1 · 📦 4 · ⏱️ 26.06.2021)
- [PyPi](https://pypi.org/project/mkdocs-theme-topdf) (📥 100 / month):
```
pip install mkdocs-theme-topdf
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: topdf
```
GitHub - 🥉6 · ⭐ 2 · 💤 · MIT ·
Theme Mkdocs Like a Github. DEMO =.
- [GitHub](https://github.com/g3xx/mkdocs-Github) (📦 11 · ⏱️ 25.02.2020)
- [PyPi](https://pypi.org/project/mkdocs-github) (📥 67 / month):
```
pip install mkdocs-github
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: github
```
mkdocs-rtl - 🥉4 · ⭐ 24 · 💤 · MIT
mkdocs rtl theme based on mkdocs-material.
- [GitHub](https://github.com/mberneti/mkdocs-rtl) (👨💻 2 · 🔀 4 · 📋 2 - 50% open · ⏱️ 22.10.2017)
Cluster - 🥉3 · ⭐ 5 · 💤 · ❗Unlicensed ·
Another bootstrap theme for MkDocs.
- [PyPi](https://pypi.org/project/mkdocs-cluster) (📥 420 / month):
```
pip install mkdocs-cluster
```
- [GitLab](https://gitlab.com/kaliko/mkdocs-cluster) (🔀 2 · ⏱️ 02.06.2016)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme):
```yaml
theme: cluster
```
## 💻 API documentation building
mkdocstrings - 🥇32 · ⭐ 1.8K · ISC ·
Automatic documentation from sources, for MkDocs.
- [GitHub](https://github.com/mkdocstrings/mkdocstrings) (👨💻 46 · 🔀 110 · 📦 16K · 📋 420 - 13% open · ⏱️ 05.12.2024)
- [PyPi](https://pypi.org/project/mkdocstrings) (📥 1.5M / month):
```
pip install mkdocstrings
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocstrings
```
mkdocstrings-python - 🥇23 · ⭐ 200 · ISC
A Python handler for mkdocstrings.
- [GitHub](https://github.com/mkdocstrings/python) (👨💻 20 · 🔀 40 · 📋 150 - 23% open · ⏱️ 26.12.2024)
- [PyPi](https://pypi.org/project/mkdocstrings-python) (📥 2.1M / month):
```
pip install mkdocstrings-python
```
mkdoxy - 🥈21 · ⭐ 78 · MIT ·
Automatically generates API documentation for your project based on Doxygen comments and code snippets in your..
- [GitHub](https://github.com/JakubAndrysek/MkDoxy) (👨💻 15 · 🔀 22 · 📦 29 · 📋 57 - 21% open · ⏱️ 22.11.2024)
- [PyPi](https://pypi.org/project/mkdoxy) (📥 9.8K / month):
```
pip install mkdoxy
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdoxy
```
MkDocsOAD - 🥈20 · ⭐ 130 · MIT ·
Plugin for MkDocs to generate human readable documentation from OpenAPI Documentation Version 3 (also known as Swagger..
- [GitHub](https://github.com/Neoteroi/mkdocs-plugins) (👨💻 10 · 🔀 9 · 📥 4K · 📦 310 · 📋 42 - 40% open · ⏱️ 04.09.2024)
- [PyPi](https://pypi.org/project/neoteroi-mkdocs) (📥 90K / month):
```
pip install neoteroi-mkdocs
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- neoteroi.mkdocsoad
- neoteroi.contribs
markdown_extensions:
- neoteroi.cards
- neoteroi.timeline
- neoteroi.projects
- neoteroi.spantable
```
MkApi - 🥈20 · ⭐ 100 · MIT ·
A plugin for MkDocs to generate API documentation.
- [GitHub](https://github.com/daizutabi/mkapi) (👨💻 5 · 🔀 17 · 📦 200 · 📋 130 - 2% open · ⏱️ 17.11.2024)
- [PyPi](https://pypi.org/project/mkapi) (📥 3.7K / month):
```
pip install mkapi
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkapi
```
mkdocs-click - 🥈18 · ⭐ 110 · Apache-2 ·
An MkDocs extension to generate documentation for Click command line applications.
- [GitHub](https://github.com/mkdocs/mkdocs-click) (👨💻 13 · 🔀 16 · 📦 670 · 📋 30 - 50% open · ⏱️ 11.02.2024)
- [PyPi](https://pypi.org/project/mkdocs-click) (📥 40K / month):
```
pip install mkdocs-click
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mkdocs-click
```
mkdocstrings-crystal - 🥈18 · ⭐ 29 · MIT
Crystal language doc generator for https://github.com/mkdocstrings/mkdocstrings.
- [GitHub](https://github.com/mkdocstrings/crystal) (👨💻 3 · 🔀 3 · 📦 780 · 📋 4 - 75% open · ⏱️ 03.02.2024)
- [PyPi](https://pypi.org/project/mkdocstrings-crystal) (📥 17K / month):
```
pip install mkdocstrings-crystal
```
MkAutoDoc - 🥈16 · ⭐ 220 · 💤 · ❗️BSD ·
Auto documentation for MkDocs.
- [GitHub](https://github.com/tomchristie/mkautodoc) (👨💻 7 · 🔀 17 · 📦 860 · 📋 18 - 38% open · ⏱️ 26.09.2022)
- [PyPi](https://pypi.org/project/mkautodoc) (📥 4.7K / month):
```
pip install mkautodoc
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mkautodoc
```
mktheapidocs - 🥉14 · ⭐ 13 · 💤 · MIT ·
Numpydocs - mkdocs friendly markdown.
- [GitHub](https://github.com/greenape/mktheapidocs) (👨💻 6 · 🔀 3 · 📦 43 · 📋 16 - 62% open · ⏱️ 10.06.2022)
- [PyPi](https://pypi.org/project/mktheapidocs) (📥 1.4K / month):
```
pip install mktheapidocs
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mktheapidocs
```
mkdocs-typer - 🥉12 · ⭐ 28 · 💤 · Apache-2 ·
An MkDocs extension to generate documentation for Typer command line applications.
- [GitHub](https://github.com/bruce-szalwinski/mkdocs-typer) (🔀 2 · 📋 7 - 57% open · ⏱️ 21.06.2023)
- [PyPi](https://pypi.org/project/mkdocs-typer) (📥 12K / month):
```
pip install mkdocs-typer
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mkdocs-typer
```
mkdocstrings-vba - 🥉12 · ⭐ 3 · ISC
VBA handler for mkdocstrings.
- [GitHub](https://github.com/mkdocstrings/vba) (👨💻 3 · 🔀 1 · 📦 3 · 📋 9 - 22% open · ⏱️ 01.10.2024)
- [PyPi](https://pypi.org/project/mkdocstrings-vba) (📥 200 / month):
```
pip install mkdocstrings-vba
```
automacdoc - 🥉7 · ⭐ 43 · 💤 · MIT
Automatic generation of documentation for mkdocs.
- [GitHub](https://github.com/AlexandreKempf/automacdoc) (👨💻 6 · 🔀 10 · 📋 5 - 80% open · ⏱️ 29.12.2020)
- [PyPi](https://pypi.org/project/automacdoc) (📥 99 / month):
```
pip install automacdoc
```
inari - 🥉7 · ⭐ 5 · 💤 · MIT ·
Write docstrings in markdown!.
- [GitHub](https://github.com/tkamenoko/inari) (📦 8 · 📋 2 - 50% open · ⏱️ 10.07.2021)
- [PyPi](https://pypi.org/project/inari) (📥 200 / month):
```
pip install inari
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- inari
```
doxygen - 🥉6 · ⭐ 16 · 💤 · MIT ·
A Doxygen plugin for MkDocs.
- [GitHub](https://github.com/pieterdavid/mkdocs-doxygen-plugin) (👨💻 3 · 🔀 5 · ⏱️ 04.12.2020)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- doxygen
```
mkdocs-typedoc - 🥉6 · ⭐ 6 · MIT ·
The MkDocs-Typedoc Plugin is a MkDocs plugin that allows you to include TypeDoc documentation in your MkDocs site.
- [GitHub](https://github.com/JakubAndrysek/mkdocs-typedoc) (👨💻 2 · 🔀 1 · ⏱️ 03.05.2024)
- [PyPi](https://pypi.org/project/mkdocs-typedoc) (📥 750 / month):
```
pip install mkdocs-typedoc
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- typedoc
```
mkdocstrings-shell - 🥉6 · ⭐ 2 · ISC
A shell scripts/libraries handler for mkdocstrings.
- [GitHub](https://github.com/mkdocstrings/shell) (📦 3 · ⏱️ 12.10.2024)
mkdocs-pipeline-visualizer - 🥉4 · ⭐ 1 · 🐣 · BSD-2 ·
Generates MD documentation from tekton pipelines and tasks.
- [GitHub](https://github.com/obegron/mkdocs-pipeline-visualizer) (👨💻 2 · 📦 1 · ⏱️ 09.09.2024)
- [PyPi](https://pypi.org/project/mkdocs-pipeline-visualizer) (📥 900 / month):
```
pip install mkdocs-pipeline-visualizer
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- pipeline-visualizer
```
mkdocs-yaarg-plugin - 🥉2 · ⭐ 2 · 💤 · ❗Unlicensed ·
Yet Another API Reference Generator plugin for MKDocs.
- [GitHub](https://github.com/g6123/mkdocs-yaarg-plugin) (📦 2 · ⏱️ 14.03.2021)
- [PyPi](https://pypi.org/project/mkdocs-yaarg-plugin) (📥 140 / month):
```
pip install mkdocs-yaarg-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- yaarg
```
ansible-document - 🥉2 · ❗Unlicensed
Auto-generate ansible role documentation.
- [PyPi](https://pypi.org/project/ansible-mkdocs) (📥 130 / month):
```
pip install ansible-mkdocs
```
## 💬 Blogging
rss - 🥇25 · ⭐ 93 · MIT ·
MkDocs plugin to generate a RSS feeds for created and updated pages, using git log and YAML frontmatter (page.meta).
- [GitHub](https://github.com/Guts/mkdocs-rss-plugin) (👨💻 17 · 🔀 26 · 📥 180 · 📦 830 · 📋 52 - 25% open · ⏱️ 01.01.2025)
- [PyPi](https://pypi.org/project/mkdocs-rss-plugin) (📥 50K / month):
```
pip install mkdocs-rss-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- rss
```
mkdocs-blogging-plugin - 🥈18 · ⭐ 84 · 💤 · MIT ·
Add blogging feature to your MkDocs site.
- [GitHub](https://github.com/liang2kl/mkdocs-blogging-plugin) (👨💻 7 · 🔀 16 · 📥 22 · 📦 270 · 📋 41 - 12% open · ⏱️ 21.07.2023)
- [PyPi](https://pypi.org/project/mkdocs-blogging-plugin) (📥 7.7K / month):
```
pip install mkdocs-blogging-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- blogging
```
Publisher for MkDocs - blog - 🥈16 · ⭐ 72 · MIT ·
Blogging engine with support for categories, tags and archive.
- [GitHub](https://github.com/mkdocs-publisher/mkdocs-publisher) (👨💻 2 · 🔀 3 · 📥 59 · 📦 66 · 📋 23 - 26% open · ⏱️ 05.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-publisher) (📥 2.3K / month):
```
pip install mkdocs-publisher
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- pub-blog
```
newsletter - 🥉12 · ⭐ 31 · ❗️GPL-3.0 ·
Automatically create newsletters from the changes in a mkdocs repository.
- [GitHub](https://github.com/lyz-code/mkdocs-newsletter) (👨💻 3 · 🔀 2 · 📦 49 · 📋 10 - 30% open · ⏱️ 27.05.2024)
- [PyPi](https://pypi.org/project/mkdocs-newsletter) (📥 580 / month):
```
pip install mkdocs-newsletter
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs-newsletter
```
Blogs for MkDocs - 🥉12 · ⭐ 17 · 💤 · MIT ·
This plugin for MkDocs allows to keeps a really simple blog section inside your documentation site.
- [GitHub](https://github.com/fmaida/mkdocs-blog-plugin) (🔀 4 · 📦 120 · 📋 2 - 50% open · ⏱️ 13.04.2020)
- [PyPi](https://pypi.org/project/mkdocs-blog-plugin) (📥 2.3K / month):
```
pip install mkdocs-blog-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- blog
```
blog - 🥉3 · ⭐ 14 · 💤 · ❗Unlicensed ·
Blogging in mkdocs.
- [GitHub](https://github.com/andyoakley/mkdocs-blog) (🔀 7 · 📋 5 - 80% open · ⏱️ 02.11.2020)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- blog
```
python-mkblog - 🥉3 · ⭐ 2 · 💤 · MIT ·
This is a MkDocs Plugin adding basic blogging functionality by parsing a `blog` directory ontop of your usual `docs`..
- [GitHub](https://github.com/derJD/python-mkblog) (👨💻 2 · 🔀 1 · ⏱️ 14.04.2021)
- [PyPi](https://pypi.org/project/mkblog) (📥 120 / month):
```
pip install mkblog
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkblog
```
## 📊 Charts, Images, Tables & Graphs
plantuml-markdown - 🥇26 · ⭐ 200 · BSD-2 ·
PlantUML plugin for Python-Markdown.
- [GitHub](https://github.com/mikitex70/plantuml-markdown) (👨💻 29 · 🔀 55 · 📦 1.6K · 📋 71 - 2% open · ⏱️ 12.09.2024)
- [PyPi](https://pypi.org/project/plantuml-markdown) (📥 340K / month):
```
pip install plantuml-markdown
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- plantuml_markdown
```
mermaid2 - 🥇23 · ⭐ 220 · MIT ·
A Mermaid graphs plugin for mkdocs.
- [GitHub](https://github.com/fralau/mkdocs-mermaid2-plugin) (👨💻 15 · 🔀 27 · 📦 2.4K · 📋 75 - 13% open · ⏱️ 15.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-mermaid2-plugin) (📥 300K / month):
```
pip install mkdocs-mermaid2-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mermaid2
```
drawio-exporter - 🥇21 · ⭐ 81 · MIT ·
Exports your Draw.io diagrams at build time for easier embedding into your documentation.
- [GitHub](https://github.com/LukeCarrier/mkdocs-drawio-exporter) (👨💻 5 · 🔀 9 · 📦 86 · 📋 30 - 13% open · ⏱️ 24.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-drawio-exporter) (📥 11K / month):
```
pip install mkdocs-drawio-exporter
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- drawio-exporter
```
kroki - 🥇21 · ⭐ 51 · 📉 · MIT ·
MkDocs plugin for Kroki-Diagrams.
- [GitHub](https://github.com/AVATEAM-IT-SYSTEMHAUS/mkdocs-kroki-plugin) (👨💻 16 · 🔀 25 · 📦 52 · 📋 40 - 15% open · ⏱️ 28.07.2024)
- [PyPi](https://pypi.org/project/mkdocs-kroki-plugin) (📥 74K / month):
```
pip install mkdocs-kroki-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- kroki
```
MkDocs GLightbox - 🥈20 · ⭐ 140 · MIT ·
A MkDocs plugin supports image lightbox (zoom effect) with GLightbox.
- [GitHub](https://github.com/blueswen/mkdocs-glightbox) (👨💻 7 · 🔀 15 · 📥 40 · 📦 3.7K · 📋 44 - 40% open · ⏱️ 16.10.2024)
- [PyPi](https://pypi.org/project/mkdocs-glightbox) (📥 240K / month):
```
pip install mkdocs-glightbox
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- glightbox
```
mkdocs_puml - 🥈20 · ⭐ 34 · MIT ·
Inline PlantUML diagrams in your MkDocs documentation.
- [GitHub](https://github.com/MikhailKravets/mkdocs_puml) (👨💻 6 · 🔀 10 · ⏱️ 25.10.2024)
- [PyPi](https://pypi.org/project/mkdocs-puml) (📥 14K / month):
```
pip install mkdocs-puml
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- plantuml
```
table-reader - 🥈19 · ⭐ 130 · MIT ·
MkDocs plugin that enables a markdown tag like {{ read_csv(table.csv) }} to directly insert various table formats into..
- [GitHub](https://github.com/timvink/mkdocs-table-reader-plugin) (👨💻 8 · 🔀 21 · 📋 53 - 1% open · ⏱️ 08.09.2024)
- [PyPi](https://pypi.org/project/mkdocs-table-reader-plugin) (📥 79K / month):
```
pip install mkdocs-table-reader-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- table-reader
```
MkDocs Video - 🥈17 · ⭐ 71 · MIT ·
MkDocs Video plugin.
- [GitHub](https://github.com/soulless-viewer/mkdocs-video) (👨💻 5 · 🔀 13 · 📥 70 · 📦 840 · ⏱️ 04.01.2024)
- [PyPi](https://pypi.org/project/mkdocs-video) (📥 61K / month):
```
pip install mkdocs-video
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs-video
```
Markdown blockdiag - 🥈17 · ⭐ 28 · 💤 · MIT ·
blockdiag extension for Python Markdown.
- [GitHub](https://github.com/gisce/markdown-blockdiag) (👨💻 5 · 🔀 10 · 📦 110 · 📋 6 - 50% open · ⏱️ 22.11.2023)
- [PyPi](https://pypi.org/project/markdown-blockdiag) (📥 2.8K / month):
```
pip install markdown-blockdiag
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- markdown_blockdiag
```
mkdocs-d2-plugin - 🥈17 · ⭐ 24 · MIT ·
A plugin for embedding D2 diagrams in MkDocs.
- [GitHub](https://github.com/landmaj/mkdocs-d2-plugin) (👨💻 3 · 🔀 5 · 📦 13 · 📋 15 - 13% open · ⏱️ 16.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-d2-plugin) (📥 79K / month):
```
pip install mkdocs-d2-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- d2
```
charts - 🥈16 · ⭐ 84 · 📉 · MIT ·
Mkdocs plugin to add plots from data using vegalite.
- [GitHub](https://github.com/timvink/mkdocs-charts-plugin) (👨💻 4 · 🔀 6 · 📦 83 · 📋 20 - 15% open · ⏱️ 22.10.2024)
- [PyPi](https://pypi.org/project/mkdocs-charts-plugin) (📥 8K / month):
```
pip install mkdocs-charts-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- charts
```
build-plantuml - 🥈16 · ⭐ 61 · MIT ·
MkDocs plugin to help generate your plantuml images locally or remotely as files (NOT inline).
- [GitHub](https://github.com/quantorconsulting/mkdocs_build_plantuml) (👨💻 11 · 🔀 16 · 📦 120 · 📋 23 - 8% open · ⏱️ 25.03.2024)
- [PyPi](https://pypi.org/project/mkdocs-build-plantuml-plugin) (📥 41K / month):
```
pip install mkdocs-build-plantuml-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- build_plantuml
```
Lightgallery - 🥈14 · ⭐ 26 · 💤 · MIT ·
Markdown extension to wrap images in a lightbox.
- [GitHub](https://github.com/g-provost/lightgallery-markdown) (👨💻 6 · 🔀 5 · 📦 96 · 📋 11 - 54% open · ⏱️ 07.10.2023)
- [PyPi](https://pypi.org/project/lightgallery) (📥 3.1K / month):
```
pip install lightgallery
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- lightgallery
```
mkdocs-diagrams - 🥈13 · ⭐ 29 · 💤 · MIT ·
MkDocs plugin to render Diagrams files.
- [GitHub](https://github.com/zoni/mkdocs-diagrams) (🔀 3 · 📦 68 · 📋 3 - 33% open · ⏱️ 04.09.2020)
- [PyPi](https://pypi.org/project/mkdocs-diagrams) (📥 56K / month):
```
pip install mkdocs-diagrams
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- diagrams
```
panzoom - 🥈13 · ⭐ 21 · 🐣 · MIT ·
MkDocs Plugin to enable pan & zoom on images and mermaid/d2 diagrams.
- [GitHub](https://github.com/PLAYG0N/mkdocs-panzoom) (👨💻 2 · 📥 28 · 📦 11 · 📋 14 - 28% open · ⏱️ 16.10.2024)
- [PyPi](https://pypi.org/project/mkdocs-panzoom-plugin) (📥 5.4K / month):
```
pip install mkdocs-panzoom-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- panzoom
```
markdownmermaid - 🥉12 · ⭐ 26 · 💤 · MIT ·
A MkDocs plugin that support mermaid graph in markdown file.
- [GitHub](https://github.com/pugong/mkdocs-mermaid-plugin) (👨💻 2 · 🔀 15 · 📦 96 · 📋 6 - 33% open · ⏱️ 26.05.2019)
- [PyPi](https://pypi.org/project/mkdocs-mermaid-plugin) (📥 6.2K / month):
```
pip install mkdocs-mermaid-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- markdownmermaid
```
Interactive Graph - 🥉12 · ⭐ 18 · MIT ·
interactive graph for Material for MkDocs like Obsidian, refer demo:.
- [GitHub](https://github.com/daxcore/mkdocs-obsidian-interactive-graph-plugin) (👨💻 2 · 🔀 2 · 📦 36 · ⏱️ 14.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-obsidian-interactive-graph-plugin) (📥 780 / month):
```
pip install mkdocs-obsidian-interactive-graph-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- obsidian-interactive-graph
```
Termage - 🥉11 · ⭐ 25 · 💤 · MIT ·
Generate SVGs from any Python code, even in your documentation.
- [GitHub](https://github.com/bczsalba/Termage) (📦 3 · 📋 5 - 20% open · ⏱️ 23.08.2022)
- [PyPi](https://pypi.org/project/Termage) (📥 280 / month):
```
pip install Termage
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- termage
```
docutools - 🥉11 · ⭐ 24 · 💤 · BSD-2 ·
Dev Centric Tools for Mkdocs Based Documentation.
- [GitHub](https://github.com/axiros/docutools) (👨💻 3 · 📦 8 · 📋 2 - 50% open · ⏱️ 04.09.2023)
- [PyPi](https://pypi.org/project/docutools) (📥 1.2K / month):
```
pip install docutools
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- lcd-find-pages
- lcd-custom-dir
- lcd-blacklist
- lcd-lp
- lcd-md-replace
- lcd-page-tree
- lcd-stats
```
MkDocs Img2Fig Plugin - 🥉10 · ⭐ 22 · 💤 · MIT ·
A MkDocs plugin that converts markdown encoded images into figure elements.
- [GitHub](https://github.com/stuebersystems/mkdocs-img2fig-plugin) (👨💻 2 · 🔀 7 · 📦 120 · 📋 3 - 66% open · ⏱️ 14.07.2020)
- [PyPi](https://pypi.org/project/mkdocs-img2fig-plugin) (📥 1K / month):
```
pip install mkdocs-img2fig-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- img2fig
```
markdown-captions - 🥉10 · ⭐ 9 · 💤 · ❗️GPL-3.0 ·
Python-Markdown plugin for image captions.
- [GitHub](https://github.com/Evidlo/markdown_captions) (👨💻 2 · 🔀 5 · 📦 170 · 📋 8 - 12% open · ⏱️ 24.05.2023)
- [PyPi](https://pypi.org/project/markdown-captions) (📥 1.9K / month):
```
pip install markdown-captions
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- markdown_captions
```
mkdocs-resize-images - 🥉9 · ⭐ 4 · 💤 · MIT ·
MkDocs plugin to resize images according to the configuration.
- [GitHub](https://github.com/JakubAndrysek/mkdocs-resize-images) (📦 12 · ⏱️ 04.11.2023)
- [PyPi](https://pypi.org/project/mkdocs-resize-images) (📥 650 / month):
```
pip install mkdocs-resize-images
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- resize-images
```
badges - 🥉8 · ⭐ 13 · MIT ·
Add badges to your mkdocs page.
- [GitHub](https://github.com/six-two/mkdocs-badges) (🔀 1 · ⏱️ 11.08.2024)
- [PyPi](https://pypi.org/project/mkdocs-badges) (📥 2.6K / month):
```
pip install mkdocs-badges
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- badges
```
markdownwavedrom - 🥉8 · ⭐ 9 · 💤 · MPL-2.0 ·
A MkDocs plugin for support wavedrom charts in markdown file.
- [GitHub](https://github.com/kuri65536/mkdocs-wavedrom-plugin) (🔀 2 · 📦 15 · 📋 3 - 33% open · ⏱️ 26.06.2021)
- [PyPi](https://pypi.org/project/mkdocs-wavedrom-plugin) (📥 240 / month):
```
pip install mkdocs-wavedrom-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- markdownwavedrom
```
plotly charts - 🥉7 · ⭐ 11 · 💤 · MIT ·
Mkdocs plugin to add interactive charts with Plotly.js.
- [GitHub](https://github.com/haoda-li/mkdocs-plotly-plugin) (👨💻 3 · ⏱️ 25.07.2023)
- [PyPi](https://pypi.org/project/mkdocs-plotly-plugin) (📥 1.7K / month):
```
pip install mkdocs-plotly-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- plotly
```
svgbob extension for Python Markdown - 🥉7 · ⭐ 7 · MIT ·
svgbob extension for Python Markdown.
- [GitHub](https://github.com/mbarkhau/markdown-svgbob) (👨💻 2 · 🔀 2 · 📦 10 · 📋 3 - 66% open · ⏱️ 21.06.2024)
- [PyPi](https://pypi.org/project/markdown-svgbob) (📥 910 / month):
```
pip install markdown-svgbob
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- markdown_svgbob
```
MkDocs Graphviz - 🥉6 · ⭐ 5 · 💤 · ❗Unlicensed ·
A mkdocs Extension that automatically renders Graphviz images, in SVG or PNG format, within your markdown file.
- [PyPi](https://pypi.org/project/mkdocs-graphviz) (📥 4.9K / month):
```
pip install mkdocs-graphviz
```
- [GitLab](https://gitlab.com/rod2ik/mkdocs-graphviz) (🔀 1 · 📋 7 - 42% open · ⏱️ 03.05.2021)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mkdocs_graphviz
```
pico-8 - 🥉6 · ⭐ 2 · 💤 · MIT ·
A MKDocs plugin that allows to embed a Pico-8 web player in a page.
- [GitHub](https://github.com/fmaida/pico8-mkdocs-plugin) (📦 3 · ⏱️ 17.03.2019)
- [PyPi](https://pypi.org/project/pico8-mkdocs-plugin) (📥 35 / month):
```
pip install pico8-mkdocs-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- pico-8
```
Markdown aafigure - 🥉5 · ⭐ 6 · MIT ·
aafigure extension for Python Markdown.
- [GitHub](https://github.com/mbarkhau/markdown-aafigure) (👨💻 2 · 🔀 1 · 📋 3 - 33% open · ⏱️ 04.05.2024)
- [PyPi](https://pypi.org/project/markdown-aafigure) (📥 440 / month):
```
pip install markdown-aafigure
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- markdown_aafigure
```
thumbnails - 🥉5 · ⭐ 2 · 💤 · MIT ·
MkDocs plugin for thumbnail images generated automatically.
- [GitHub](https://github.com/normanlorrain/mkdocs-thumbnails) (📋 2 - 50% open · ⏱️ 05.06.2023)
- [PyPi](https://pypi.org/project/mkdocs-thumbnails) (📥 210 / month):
```
pip install mkdocs-thumbnails
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- thumbnails
```
markdown-figcap - 🥉5 · ⭐ 1 · 💤 · BSD-3 ·
Extension for Python-Markdown to handle figure and figcaption.
- [GitHub](https://github.com/funk1d/markdown-figcap) (📦 7 · ⏱️ 09.03.2019)
- [PyPi](https://pypi.org/project/markdown-figcap) (📥 81 / month):
```
pip install markdown-figcap
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- markdown_figcap
```
inline-svg - 🥉5 · MIT ·
- [GitHub](https://github.com/rajguru7/mkdocs-plugin-inline-svg-mod) (👨💻 5 · 🔀 1 · 📦 7 · ⏱️ 12.01.2024)
- [PyPi](https://pypi.org/project/mkdocs-plugin-inline-svg-mod) (📥 420 / month):
```
pip install mkdocs-plugin-inline-svg-mod
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- inline-svg
```
import-statement - 🥉4 · ⭐ 2 · 💤 · MIT ·
- [GitHub](https://github.com/Rj40x40/mkdocs-import-statement-plugin) (📦 3 · ⏱️ 06.02.2023)
- [PyPi](https://pypi.org/project/mkdocs-import-statement-plugin) (📥 82 / month):
```
pip install mkdocs-import-statement-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- import-statement
```
Family tree example - 🥉4 · ⭐ 2 · 💤 · ❗️GPL-3.0
An interactive family tree visualization using d3-dag.
- [GitHub](https://github.com/unverbuggt/mkdocs-familytree-example) (👨💻 6 · 🔀 1 · ⏱️ 04.08.2023)
sequence-js - 🥉3 · ⭐ 4 · 💤 · MIT ·
MkDocs plugin to render sequence.js blocks.
- [GitHub](https://github.com/fcannizzaro/mkdocs-sequence-js-plugin) (🔀 2 · 📋 3 - 33% open · ⏱️ 28.02.2020)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- sequence-js
```
image-formatter-plugin - 🥉3 · ⭐ 3 · 💤 · ❗Unlicensed ·
- [GitHub](https://github.com/ASypula/mkdocs-image-formatter-plugin) (👨💻 7 · 📦 2 · ⏱️ 06.12.2023)
- [PyPi](https://pypi.org/project/mkdocs-image-formatter-plugin) (📥 45 / month):
```
pip install mkdocs-image-formatter-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- image-formatter
```
MkHack3rs - 🥉2 · ⭐ 4 · 💤 · ❗Unlicensed ·
Hacks & Integrations for Mkdocs / Material Theme.
- [GitLab](https://gitlab.com/eskool/mkhack3rs) (🔀 1 · ⏱️ 01.05.2021)
## 🤖 Code execution, variables & templating
macros - 🥇30 · ⭐ 340 · MIT ·
Create richer and more beautiful pages in MkDocs, by using variables and calls to macros in the markdown code.
- [GitHub](https://github.com/fralau/mkdocs-macros-plugin) (👨💻 34 · 🔀 48 · 📦 4.3K · 📋 130 - 0% open · ⏱️ 07.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-macros-plugin) (📥 490K / month):
```
pip install mkdocs-macros-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- macros
```
mkdocs-jupyter - 🥇24 · ⭐ 420 · Apache-2 ·
Use Jupyter Notebook in mkdocs.
- [GitHub](https://github.com/danielfrg/mkdocs-jupyter) (👨💻 32 · 🔀 53 · 📦 3.2K · 📋 140 - 22% open · ⏱️ 15.10.2024)
- [PyPi](https://pypi.org/project/mkdocs-jupyter) (📥 140K / month):
```
pip install mkdocs-jupyter
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs-jupyter
```
markdown-exec - 🥈21 · ⭐ 120 · ISC ·
Utilities to execute code blocks in Markdown files.
- [GitHub](https://github.com/pawamoy/markdown-exec) (👨💻 3 · 🔀 9 · 📦 400 · 📋 53 - 18% open · ⏱️ 06.12.2024)
- [PyPi](https://pypi.org/project/markdown-exec) (📥 51K / month):
```
pip install markdown-exec
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- markdown-exec
```
markdownextradata - 🥈21 · ⭐ 86 · MIT ·
A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template.
- [GitHub](https://github.com/rosscdh/mkdocs-markdownextradata-plugin) (👨💻 12 · 🔀 17 · 📦 1.3K · 📋 35 - 17% open · ⏱️ 22.08.2024)
- [PyPi](https://pypi.org/project/mkdocs-markdownextradata-plugin) (📥 69K / month):
```
pip install mkdocs-markdownextradata-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- markdownextradata
```
mknotebooks - 🥈20 · ⭐ 140 · 💤 · MIT ·
A plugin for mkdocs to help you include Jupyter notebooks in your projects.
- [GitHub](https://github.com/greenape/mknotebooks) (👨💻 14 · 🔀 20 · 📦 640 · 📋 40 - 35% open · ⏱️ 11.08.2023)
- [PyPi](https://pypi.org/project/mknotebooks) (📥 42K / month):
```
pip install mknotebooks
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mknotebooks
```
gen-files - 🥈20 · ⭐ 120 · MIT ·
MkDocs plugin to programmatically generate documentation pages during the build.
- [GitHub](https://github.com/oprypin/mkdocs-gen-files) (👨💻 5 · 🔀 10 · 📦 2.7K · 📋 27 - 29% open · ⏱️ 07.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-gen-files) (📥 340K / month):
```
pip install mkdocs-gen-files
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- gen-files
```
Termynal - 🥈15 · ⭐ 100 · MIT ·
Python markdown terminal. Built for mkdocs.
- [GitHub](https://github.com/termynal/termynal.py) (👨💻 6 · 🔀 8 · 📦 260 · 📋 16 - 50% open · ⏱️ 16.12.2024)
- [PyPi](https://pypi.org/project/termynal) (📥 7.3K / month):
```
pip install termynal
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- termynal
```
mkdocs-markmap - 🥈15 · ⭐ 53 · 💤 · MIT ·
MkDocs plugin and extension to create mindmaps from markdown using markmap.
- [GitHub](https://github.com/markmap/mkdocs-markmap) (👨💻 3 · 🔀 5 · 📥 360 · 📋 28 - 10% open · ⏱️ 05.10.2023)
- [PyPi](https://pypi.org/project/mkdocs-markmap) (📥 1.9K / month):
```
pip install mkdocs-markmap
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- markmap
```
pheasant - 🥉14 · ⭐ 16 · MIT ·
Documentation tool for Markdown conversion by Jupyter client.
- [GitHub](https://github.com/daizutabi/pheasant) (👨💻 4 · 🔀 9 · 📦 54 · ⏱️ 27.09.2024)
- [PyPi](https://pypi.org/project/pheasant) (📥 1.7K / month):
```
pip install pheasant
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- pheasant
```
user-defined-values - 🥉12 · ⭐ 4 · 💤 · MIT ·
MkDocs User Defined Values.
- [GitHub](https://github.com/rahult/mkdocs-user-defined-values) (👨💻 3 · 🔀 3 · 📥 16 · 📦 15 · ⏱️ 10.07.2022)
- [PyPi](https://pypi.org/project/mkdocs-user-defined-values) (📥 540 / month):
```
pip install mkdocs-user-defined-values
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- user-defined-values
```
placeholder - 🥉9 · ⭐ 15 · MIT ·
Add placeholders to your MkDocs pages.
- [GitHub](https://github.com/six-two/mkdocs-placeholder-plugin) (👨💻 2 · 🔀 3 · ⏱️ 20.10.2024)
- [PyPi](https://pypi.org/project/mkdocs-placeholder-plugin) (📥 11K / month):
```
pip install mkdocs-placeholder-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- placeholder
```
meta-manager - 🥉9 · ⭐ 2 · MIT ·
MkDocs plugin for managing meta tags across folders and files.
- [GitHub](https://github.com/timmeinerzhagen/mkdocs-meta-manager) (👨💻 3 · 🔀 1 · 📦 10 · 📋 3 - 33% open · ⏱️ 09.05.2024)
- [PyPi](https://pypi.org/project/mkdocs-meta-manager) (📥 3K / month):
```
pip install mkdocs-meta-manager
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- meta-manager
```
nbconvert - 🥉8 · ⭐ 9 · BSD-2 ·
A MkDocs plug-in provides a source parser for *.ipynb files.
- [GitHub](https://github.com/tanbro/mkdocs-nbconvert) (👨💻 5 · 🔀 1 · 📦 5 · ⏱️ 06.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-nbconvert) (📥 830 / month):
```
pip install mkdocs-nbconvert
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- nbconvert
```
markdown-filter - 🥉8 · ⭐ 5 · 💤 · MIT ·
Adds a markdown template filter to the jinja templating environment in mkdocs.
- [GitHub](https://github.com/byrnereese/mkdocs-markdown-filter) (🔀 2 · 📦 29 · ⏱️ 06.02.2019)
- [PyPi](https://pypi.org/project/mkdocs-markdown-filter) (📥 520 / month):
```
pip install mkdocs-markdown-filter
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- markdown-filter
```
mkjsfiddle - 🥉8 · ⭐ 4 · 💤 · MIT ·
An MkDocs plugin that lets you edit code fences in JSFiddle.
- [GitHub](https://github.com/stadiamaps/mkjsfiddle) (📦 3 · ⏱️ 07.06.2023)
- [PyPi](https://pypi.org/project/mkjsfiddle) (📥 140 / month):
```
pip install mkjsfiddle
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- jsfiddle
```
mkdocs-data-plugin - 🥉8 · ⭐ 2 · 🐣 · MIT ·
Mkdocs plugin that allows reading data from markup files and use it in your Markdown pages.
- [GitHub](https://github.com/joapuiib/mkdocs-data-plugin) (⏱️ 26.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-data-plugin) (📥 700 / month):
```
pip install mkdocs-data-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- data
```
Entangled - 🥉7 · ⭐ 2 · 💤 · Apache-2 ·
An MkDocs plugin that lets you do Literate Programming through Entangled.
- [GitHub](https://github.com/entangled/mkdocs-plugin) (📦 9 · ⏱️ 14.10.2023)
- [PyPi](https://pypi.org/project/mkdocs-entangled-plugin) (📥 150 / month):
```
pip install mkdocs-entangled-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- entangled
```
jinja2sandbox - 🥉5 · ⭐ 4 · 💤 · MIT ·
A MkDocs plugin that enables the Jinja2-sandbox.
- [GitHub](https://github.com/rkoe/mkdocs-jinja2sandbox) (⏱️ 20.03.2019)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- jinja2sandbox
```
codeyaml - 🥉5 · 💤 · MIT ·
Allows for more than one yaml config in mkdocs.
- [GitHub](https://github.com/textileio/mkdocs-codeyaml-plugin) (🔀 1 · 📦 2 · ⏱️ 30.04.2019)
- [PyPi](https://pypi.org/project/mkdocs-codeyaml-plugin) (📥 95 / month):
```
pip install mkdocs-codeyaml-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- codeyaml
```
mkdocs_protobuf - 🥉4 · ⭐ 2 · 💤 · Apache-2 ·
Mkdocs plugin to render protobuf messages.
- [GitHub](https://github.com/rymurr/mkdocs-protobuf) (👨💻 2 · 🔀 1 · ⏱️ 30.03.2022)
- [PyPi](https://pypi.org/project/mkdocs-protobuf) (📥 210 / month):
```
pip install mkdocs-protobuf
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs_protobuf
```
## 🌲 Git repos & info
git-revision-date-localized - 🥇29 · ⭐ 210 · MIT ·
MkDocs plugin to add a last updated date to your site pages.
- [GitHub](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) (👨💻 31 · 🔀 43 · 📦 8.4K · 📋 98 - 10% open · ⏱️ 02.01.2025)
- [PyPi](https://pypi.org/project/mkdocs-git-revision-date-localized-plugin) (📥 590K / month):
```
pip install mkdocs-git-revision-date-localized-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- git-revision-date-localized
```
git-authors - 🥈25 · ⭐ 91 · MIT ·
MkDocs plugin to display git authors of a page.
- [GitHub](https://github.com/timvink/mkdocs-git-authors-plugin) (👨💻 14 · 🔀 19 · 📦 1.3K · 📋 61 - 18% open · ⏱️ 04.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-git-authors-plugin) (📥 140K / month):
```
pip install mkdocs-git-authors-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- git-authors
```
git-committers-2 - 🥈22 · ⭐ 62 · 📉 · MIT ·
An MkDocs plugin to create a list of contributors on the page.
- [GitHub](https://github.com/ojacques/mkdocs-git-committers-plugin-2) (👨💻 17 · 🔀 21 · 📦 870 · 📋 43 - 20% open · ⏱️ 24.10.2024)
- [PyPi](https://pypi.org/project/mkdocs-git-committers-plugin-2) (📥 65K / month):
```
pip install mkdocs-git-committers-plugin-2
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- git-committers
```
git-revision-date - 🥈20 · ⭐ 57 · 💤 · MIT ·
MkDocs plugin for setting revision date from git per markdown file.
- [GitHub](https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin) (👨💻 7 · 🔀 8 · 📦 2.5K · 📋 14 - 35% open · ⏱️ 08.03.2022)
- [PyPi](https://pypi.org/project/mkdocs-git-revision-date-plugin) (📥 70K / month):
```
pip install mkdocs-git-revision-date-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- git-revision-date
```
git-committers - 🥉15 · ⭐ 42 · MIT ·
A mkdocs plugin for displaying the last commit and a list of a files contributors.
- [GitHub](https://github.com/byrnereese/mkdocs-git-committers-plugin) (👨💻 7 · 🔀 7 · 📦 250 · 📋 8 - 87% open · ⏱️ 12.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-git-committers-plugin) (📥 24K / month):
```
pip install mkdocs-git-committers-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- git-committers
```
mkdocs-git-latest-changes-plugin - 🥉11 · ⭐ 1 · MIT ·
MkDocs plugin that allows you to display a list of recently modified pages from the Git log.
- [GitHub](https://github.com/tombreit/mkdocs-git-latest-changes-plugin) (👨💻 2 · 🔀 2 · 📦 5 · 📋 13 - 7% open · ⏱️ 27.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-git-latest-changes-plugin) (📥 18K / month):
```
pip install mkdocs-git-latest-changes-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- git-latest-changes
```
Github-Links - 🥉8 · ⭐ 10 · 💤 · ❗Unlicensed ·
Python-Markdown GitHub Links Extension.
- [GitHub](https://github.com/Python-Markdown/github-links) (👨💻 4 · 🔀 9 · ⏱️ 22.12.2023)
- [PyPi](https://pypi.org/project/mdx-gh-links) (📥 5.3K / month):
```
pip install mdx-gh-links
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mdx_gh_links
```
branchcustomization - 🥉7 · ⭐ 2 · 💤 · MIT ·
Customize MkDocs options on a per-branch basis.
- [GitHub](https://github.com/effigies/mkdocs-branchcustomization-plugin) (📦 17 · ⏱️ 17.04.2022)
- [PyPi](https://pypi.org/project/mkdocs-branchcustomization-plugin) (📥 860 / month):
```
pip install mkdocs-branchcustomization-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- branchcustomization
```
Github Releaase Changelog - 🥉6 · ⭐ 5 · MIT ·
mkdocs extension to autogenerate changelog from github releases.
- [GitHub](https://github.com/djpugh/mkdocs_github_changelog) (👨💻 2 · ⏱️ 02.01.2024)
- [PyPi](https://pypi.org/project/mkdocs-github-changelog) (📥 340 / month):
```
pip install mkdocs-github-changelog
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs_github_changelog
```
git-latest-release - 🥉4 · ⭐ 2 · 💤 · ❗️GPL-3.0 ·
Plugin for MKDocs to inject the latest release tag from git into markdown.
- [GitHub](https://github.com/agarthetiger/mkdocs_latest_release_plugin) (👨💻 3 · ⏱️ 29.12.2019)
- [PyPi](https://pypi.org/project/mkdocs-latest-release-plugin) (📥 1K / month):
```
pip install mkdocs-latest-release-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- git-latest-release
```
## 🌈 HTML processing & CSS styling
minify - 🥇22 · ⭐ 160 · MIT ·
A mkdocs plugin to minify the HTML of a page before it is written to disk.
- [GitHub](https://github.com/byrnereese/mkdocs-minify-plugin) (👨💻 14 · 🔀 18 · 📦 8.8K · 📋 18 - 27% open · ⏱️ 29.01.2024)
- [PyPi](https://pypi.org/project/mkdocs-minify-plugin) (📥 190K / month):
```
pip install mkdocs-minify-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- minify
```
enumerate-headings - 🥇19 · ⭐ 41 · MIT ·
MkDocs Plugin to enumerate the headings across site pages.
- [GitHub](https://github.com/timvink/mkdocs-enumerate-headings-plugin) (👨💻 5 · 🔀 9 · 📦 270 · 📋 32 - 12% open · ⏱️ 16.04.2024)
- [PyPi](https://pypi.org/project/mkdocs-enumerate-headings-plugin) (📥 26K / month):
```
pip install mkdocs-enumerate-headings-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- enumerate-headings
```
minify-html - 🥈18 · ⭐ 9 · MIT ·
MkDocs plugin for minification using minify-html, an extremely fast and smart HTML + JS + CSS minifier.
- [GitHub](https://github.com/monosans/mkdocs-minify-html-plugin) (👨💻 4 · 📦 50 · ⏱️ 31.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-minify-html-plugin) (📥 15K / month):
```
pip install mkdocs-minify-html-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- minify_html
```
Publisher for MkDocs - social - 🥈16 · ⭐ 72 · MIT ·
Social media sharing helper.
- [GitHub](https://github.com/mkdocs-publisher/mkdocs-publisher) (👨💻 2 · 🔀 3 · 📥 59 · 📦 66 · 📋 23 - 26% open · ⏱️ 05.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-publisher) (📥 2.3K / month):
```
pip install mkdocs-publisher
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- pub-social
```
Publisher for MkDocs - minifier - 🥈16 · ⭐ 72 · MIT ·
Size optimization (minification) for HTML, CSS, JS, SVG, PNG and JPEG files.
- [GitHub](https://github.com/mkdocs-publisher/mkdocs-publisher) (👨💻 2 · 🔀 3 · 📥 59 · 📦 66 · 📋 23 - 26% open · ⏱️ 05.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-publisher) (📥 2.3K / month):
```
pip install mkdocs-publisher
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- pub-minifier
```
add-number - 🥈13 · ⭐ 17 · 💤 · MIT ·
MkDocs plugin to automatically number the headings (h1-h6) in each markdown page and the nav.
- [GitHub](https://github.com/ignorantshr/mkdocs-add-number-plugin) (👨💻 3 · 🔀 4 · 📦 47 · 📋 12 - 25% open · ⏱️ 11.06.2020)
- [PyPi](https://pypi.org/project/mkdocs-add-number-plugin) (📥 11K / month):
```
pip install mkdocs-add-number-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- add-number
```
mkdocs-extra-sass-plugin - 🥈13 · ⭐ 3 · 💤 · MIT ·
Adds stylesheets to your mkdocs site from Sass/SCSS.
- [GitHub](https://github.com/orzih/mkdocs-extra-sass-plugin) (🔀 3 · 📦 57 · ⏱️ 13.02.2021)
- [PyPi](https://pypi.org/project/mkdocs-extra-sass-plugin) (📥 28K / month):
```
pip install mkdocs-extra-sass-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- extra-sass
```
mkdocs-link-embeds - 🥉12 · ⭐ 6 · MIT ·
Mkdocs plugin which displays links in a more elegant way. Links will automatically be populated with an image,..
- [GitHub](https://github.com/Aetherinox/mkdocs-link-embeds) (📥 23 · 📦 8 · ⏱️ 13.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-link-embeds-plugin) (📥 620 / month):
```
pip install mkdocs-link-embeds-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- link-embeds
```
mkdocs-ai-summary - 🥉10 · ⭐ 6 · MIT ·
A mkdocs plugin to generage summary with the help of AI.
- [GitHub](https://github.com/AIboy996/mkdocs-ai-summary) (🔀 1 · 📦 3 · ⏱️ 27.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-ai-summary) (📥 410 / month):
```
pip install mkdocs-ai-summary
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- ai-summary
```
mkdocs_safe_text - 🥉10 · ⭐ 4 · BSD-2 ·
Plugin for safe text editing with MKDocs.
- [GitHub](https://github.com/raimon49/mkdocs-safe-text-plugin) (👨💻 2 · 📦 9 · ⏱️ 22.07.2024)
- [PyPi](https://pypi.org/project/mkdocs-safe-text-plugin) (📥 960 / month):
```
pip install mkdocs-safe-text-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs_safe_text
```
bootstrap-tables - 🥉9 · ⭐ 12 · 💤 · MIT ·
A MkDocs plugin to add bootstrap classes to plan markdown generated tables.
- [GitHub](https://github.com/byrnereese/mkdocs-bootstrap-tables-plugin) (🔀 2 · 📦 90 · ⏱️ 27.03.2020)
- [PyPi](https://pypi.org/project/mkdocs-bootstrap-tables-plugin) (📥 1.5K / month):
```
pip install mkdocs-bootstrap-tables-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- bootstrap-tables
```
mkdocs-add-teaser - 🥉9 · ⭐ 4 · 💤 · MIT ·
An MkDocs plugin to customize the first paragraph of your pages, and to use it as the pages meta description.
- [GitHub](https://github.com/wilhelmer/mkdocs-add-teaser) (👨💻 3 · 🔀 1 · 📦 5 · ⏱️ 08.11.2022)
- [PyPi](https://pypi.org/project/mkdocs-add-teaser) (📥 520 / month):
```
pip install mkdocs-add-teaser
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs-add-teaser
```
toggle-sidebar - 🥉7 · ⭐ 5 · MIT ·
Toggle the navigation and/or TOC sidebars on your MkDocs site.
- [GitHub](https://github.com/six-two/mkdocs-toggle-sidebar-plugin) (⏱️ 10.09.2024)
- [PyPi](https://pypi.org/project/mkdocs-toggle-sidebar-plugin) (📥 1.7K / month):
```
pip install mkdocs-toggle-sidebar-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- toggle-sidebar
```
MkDocs Pygments - 🥉5 · ⭐ 7 · ISC ·
Highlighting themes for code blocks. Available to sponsors only.
- [GitHub](https://github.com/pawamoy/mkdocs-pygments) (🔀 1 · 📦 2 · ⏱️ 24.05.2024)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- pygments
```
docstyler - 🥉3 · ⭐ 1 · 💤 · BSD-3 ·
Plugin to add alternative stylesheets to MkDocs custom themes.
- [GitHub](https://github.com/hfagerlund/mkdocs-docstyler-plugin) (⏱️ 16.02.2019)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- docstyler
```
## 📎 Integrations with other tools
MkDocs Swagger UI Tag - 🥇17 · ⭐ 82 · MIT ·
A MkDocs plugin supports adding Swagger UI to the page.
- [GitHub](https://github.com/blueswen/mkdocs-swagger-ui-tag) (👨💻 4 · 🔀 8 · 📥 47 · 📦 230 · 📋 23 - 26% open · ⏱️ 27.10.2024)
- [PyPi](https://pypi.org/project/mkdocs-swagger-ui-tag) (📥 42K / month):
```
pip install mkdocs-swagger-ui-tag
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- swagger-ui-tag
```
mkdocs-coverage - 🥇17 · ⭐ 24 · ISC ·
MkDocs plugin to integrate your coverage HTML report into your site.
- [GitHub](https://github.com/pawamoy/mkdocs-coverage) (🔀 1 · 📦 240 · 📋 10 - 40% open · ⏱️ 11.06.2024)
- [PyPi](https://pypi.org/project/mkdocs-coverage) (📥 25K / month):
```
pip install mkdocs-coverage
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- coverage
```
Publisher for MkDocs - obsidian - 🥈16 · ⭐ 72 · MIT ·
Obsidian.md integration including with support for wiki links, callouts, backlinks etc.
- [GitHub](https://github.com/mkdocs-publisher/mkdocs-publisher) (👨💻 2 · 🔀 3 · 📥 59 · 📦 66 · 📋 23 - 26% open · ⏱️ 05.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-publisher) (📥 2.3K / month):
```
pip install mkdocs-publisher
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- pub-obsidian
```
MkDocs asciinema-player - 🥈16 · ⭐ 8 · MIT ·
Mkdocs Plugin to include asciinema player in your documentation.
- [GitHub](https://github.com/pa-decarvalho/mkdocs-asciinema-player) (👨💻 3 · 🔀 1 · 📦 4 · 📋 26 - 11% open · ⏱️ 13.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-asciinema-player) (📥 1.2K / month):
```
pip install mkdocs-asciinema-player
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- asciinema-player
```
mkdocs-render-swagger-plugin - 🥉14 · ⭐ 75 · MIT ·
A plugin for MKDocs for rendering swagger & openapi schemas using SwaggerUI.
- [GitHub](https://github.com/bharel/mkdocs-render-swagger-plugin) (👨💻 8 · 🔀 12 · 📥 6 · 📋 15 - 20% open · ⏱️ 23.09.2024)
- [PyPi](https://pypi.org/project/mkdocs-render-swagger-plugin) (📥 56K / month):
```
pip install mkdocs-render-swagger-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- render_swagger
```
MkDocs Backend for Foliant - 🥉12 · ⭐ 3 · 💤 · MIT
MkDocs backend for Foliant.
- [GitHub](https://github.com/foliant-docs/foliantcontrib.mkdocs) (👨💻 5 · 🔀 3 · 📦 35 · ⏱️ 12.12.2022)
- [PyPi](https://pypi.org/project/foliantcontrib.mkdocs) (📥 680 / month):
```
pip install foliantcontrib.mkdocs
```
swagger - 🥉6 · ⭐ 30 · 💤 · MIT ·
MkDocs plugin for render swagger into docs.
- [GitHub](https://github.com/allevo/mkdocs-swagger-plugin) (🔀 6 · 📋 5 - 60% open · ⏱️ 06.10.2019)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- swagger
```
factsheet - 🥉6 · ⭐ 4 · 💤 · MIT ·
Generate overviews from YAML descriptions, intended for micro-services and their deployments.
- [GitHub](https://github.com/inuits/mkdocs-factsheet) (👨💻 4 · 🔀 1 · ⏱️ 08.02.2023)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- factsheet
```
MkDocs Dependency License Information - 🥉6 · ⭐ 3 · MIT ·
mkdocs extension to visualise package dependencies license information.
- [GitHub](https://github.com/djpugh/mkdocs_licenseinfo) (👨💻 2 · ⏱️ 02.01.2024)
- [PyPi](https://pypi.org/project/mkdocs-licenseinfo) (📥 230 / month):
```
pip install mkdocs-licenseinfo
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs_licenseinfo
```
Vercel Password Protection - 🥉5 · MIT ·
Allows you to password protect your site if it is deployed by Vercel, by adding routes to the vercel.json file.
- [GitHub](https://github.com/six-two/mkdocs-vercel-pw-plugin) (⏱️ 11.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-vercel-pw-plugin) (📥 100 / month):
```
pip install mkdocs-vercel-pw-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- vercel_pw
```
## 🌍 Internationalization & localization
static-i18n - 🥇21 · ⭐ 240 · MIT ·
MkDocs i18n plugin using static translation markdown files.
- [GitHub](https://github.com/ultrabug/mkdocs-static-i18n) (👨💻 12 · 🔀 38 · 📦 1.3K · 📋 140 - 14% open · ⏱️ 12.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-static-i18n) (📥 52K / month):
```
pip install mkdocs-static-i18n
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- i18n
```
mkdocs-mdpo - 🥉11 · ⭐ 7 · BSD-3 ·
Mkdocs translation plugin using PO files.
- [GitHub](https://github.com/mondeja/mkdocs-mdpo-plugin) (👨💻 4 · 🔀 5 · 📥 260 · 📋 37 - 35% open · ⏱️ 10.06.2024)
- [PyPi](https://pypi.org/project/mkdocs-mdpo-plugin) (📥 630 / month):
```
pip install mkdocs-mdpo-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mdpo
```
Mkdocs translations plugin - 🥉2 · ❗Unlicensed ·
Internationalization plugin for mkdocs.
- [PyPi](https://pypi.org/project/mkdocs-translations) (📥 37 / month):
```
pip install mkdocs-translations
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- translations
```
## 🔗 Links & references
mkdocs-redirects - 🥇26 · ⭐ 180 · MIT ·
Open source plugin for Mkdocs page redirects.
- [GitHub](https://github.com/mkdocs/mkdocs-redirects) (👨💻 16 · 🔀 22 · 📦 4.5K · 📋 39 - 28% open · ⏱️ 07.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-redirects) (📥 430K / month):
```
pip install mkdocs-redirects
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- redirects
```
bibtex - 🥇21 · ⭐ 80 · ❗️BSD-3-Clause-LBNL ·
A MkDocs plugin for citation management using bibtex.
- [GitHub](https://github.com/shyamd/mkdocs-bibtex) (👨💻 14 · 🔀 21 · 📦 350 · 📋 45 - 28% open · ⏱️ 01.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-bibtex) (📥 24K / month):
```
pip install mkdocs-bibtex
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- bibtex
```
htmlproofer - 🥇20 · ⭐ 44 · MIT ·
A MkDocs plugin that validates URL in rendered html files.
- [GitHub](https://github.com/manuzhang/mkdocs-htmlproofer-plugin) (👨💻 15 · 🔀 16 · 📦 400 · 📋 36 - 8% open · ⏱️ 23.09.2024)
- [PyPi](https://pypi.org/project/mkdocs-htmlproofer-plugin) (📥 26K / month):
```
pip install mkdocs-htmlproofer-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- htmlproofer
```
autorefs - 🥈19 · ⭐ 54 · ISC ·
Automatically link across pages in MkDocs.
- [GitHub](https://github.com/mkdocstrings/autorefs) (👨💻 8 · 🔀 10 · 📋 24 - 8% open · ⏱️ 01.09.2024)
- [PyPi](https://pypi.org/project/mkdocs-autorefs) (📥 1.3M / month):
```
pip install mkdocs-autorefs
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- autorefs
```
mkdocs-open-in-new-tab - 🥈18 · ⭐ 28 · MIT ·
This plugin adds JS to open outgoing links and PDFs in a new tab.
- [GitHub](https://github.com/JakubAndrysek/mkdocs-open-in-new-tab) (👨💻 2 · 🔀 4 · 📦 360 · 📋 7 - 28% open · ⏱️ 18.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-open-in-new-tab) (📥 74K / month):
```
pip install mkdocs-open-in-new-tab
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- open-in-new-tab
```
autolinks - 🥈17 · ⭐ 80 · 💤 · MIT ·
An MkDocs plugin that automagically generates relative links between markdown pages.
- [GitHub](https://github.com/zachhannum/mkdocs-autolinks-plugin) (👨💻 10 · 🔀 16 · 📦 540 · 📋 18 - 50% open · ⏱️ 04.08.2023)
- [PyPi](https://pypi.org/project/mkdocs-autolinks-plugin) (📥 34K / month):
```
pip install mkdocs-autolinks-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- autolinks
```
ezlinks - 🥈14 · ⭐ 35 · 💤 · MIT ·
Plugin for mkdocs which enables easier linking between pages.
- [GitHub](https://github.com/orbikm/mkdocs-ezlinks-plugin) (🔀 13 · 📥 210 · 📦 120 · 📋 26 - 42% open · ⏱️ 24.01.2022)
- [PyPi](https://pypi.org/project/mkdocs-ezlinks-plugin) (📥 2.8K / month):
```
pip install mkdocs-ezlinks-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- ezlinks
```
mkdocs-alias-plugin - 🥈13 · ⭐ 15 · MIT ·
An MkDocs plugin allowing links to your pages using a custom alias.
- [GitHub](https://github.com/EddyLuten/mkdocs-alias-plugin) (👨💻 3 · 🔀 3 · 📦 30 · 📋 11 - 27% open · ⏱️ 22.04.2024)
- [PyPi](https://pypi.org/project/mkdocs-alias-plugin) (📥 1.4K / month):
```
pip install mkdocs-alias-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- alias
```
roamlinks - 🥈12 · ⭐ 52 · 💤 · MIT ·
An MkDocs plugin that automagically generates relative links between markdown pages.
- [GitHub](https://github.com/Jackiexiao/mkdocs-roamlinks-plugin) (👨💻 9 · 🔀 15 · ⏱️ 08.06.2023)
- [PyPi](https://pypi.org/project/mkdocs-roamlinks-plugin) (📥 8.2K / month):
```
pip install mkdocs-roamlinks-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- roamlinks
```
unused-files - 🥈12 · ⭐ 10 · 💤 · MIT ·
An MkDocs plugin to find unused (orphaned) files in your project.
- [GitHub](https://github.com/wilhelmer/mkdocs-unused-files) (👨💻 2 · 🔀 3 · 📦 25 · 📋 10 - 20% open · ⏱️ 17.07.2023)
- [PyPi](https://pypi.org/project/mkdocs-unused-files) (📥 2.6K / month):
```
pip install mkdocs-unused-files
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- unused_files
```
Autolink References - 🥉11 · ⭐ 18 · 💤 · MIT ·
mkdocs plugin to provides GitHub like autolink references in Mkdocs.
- [GitHub](https://github.com/theskumar/autolink-references-mkdocs-plugin) (👨💻 3 · 🔀 6 · 📦 9 · 📋 4 - 25% open · ⏱️ 28.12.2023)
- [PyPi](https://pypi.org/project/autolink-references-mkdocs-plugin) (📥 5.4K / month):
```
pip install autolink-references-mkdocs-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- autolink_references
```
mkdocs-site-urls - 🥉10 · ⭐ 16 · 💤 · MIT ·
A MkDocs plugin that adds support for site-relative `site:` URLs.
- [GitHub](https://github.com/OctoPrint/mkdocs-site-urls) (🔀 1 · 📦 24 · 📋 2 - 50% open · ⏱️ 31.07.2023)
- [PyPi](https://pypi.org/project/mkdocs-site-urls) (📥 5.9K / month):
```
pip install mkdocs-site-urls
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- site-urls
```
link-marker - 🥉9 · ⭐ 8 · MIT ·
MkDocs plugin for marking links e.g. external ones or mails.
- [GitHub](https://github.com/timmeinerzhagen/mkdocs-link-marker) (👨💻 2 · 🔀 1 · 📦 22 · 📋 4 - 50% open · ⏱️ 25.02.2024)
- [PyPi](https://pypi.org/project/mkdocs-link-marker) (📥 3.3K / month):
```
pip install mkdocs-link-marker
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- link-marker
```
abs-to-rel - 🥉9 · ⭐ 5 · 💤 · MIT ·
MkDocs plugin for converting absolute links to relative ones.
- [GitHub](https://github.com/sander76/mkdocs-abs-rel-plugin) (👨💻 2 · 🔀 3 · 📦 28 · ⏱️ 03.03.2020)
- [PyPi](https://pypi.org/project/mkdocs-abs-rel-plugin) (📥 3.2K / month):
```
pip install mkdocs-abs-rel-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- abs-to-rel
```
Wikilink Plus - 🥉8 · ⭐ 16 · 💤 · ❗Unlicensed ·
A wikilink extension for Python Markdown.
- [GitHub](https://github.com/neurobin/mdx_wikilink_plus) (👨💻 5 · 🔀 4 · ⏱️ 26.07.2022)
- [PyPi](https://pypi.org/project/mdx-wikilink-plus) (📥 3.3K / month):
```
pip install mdx-wikilink-plus
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mdx_wikilink_plus
```
ezglossary - 🥉8 · ⭐ 11 · MIT ·
Glossary support for mkdocs.
- [GitHub](https://github.com/realtimeprojects/mkdocs-ezglossary) (👨💻 2 · 🔀 1 · 📋 22 - 9% open · ⏱️ 11.10.2024)
- [PyPi](https://pypi.org/project/mkdocs-ezglossary-plugin) (📥 4.4K / month):
```
pip install mkdocs-ezglossary-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- ezglossary
```
tooltipster-links - 🥉8 · ⭐ 8 · 💤 · MIT ·
An MkDocs plugin that adds tooltips to preview the content of page links using tooltipster.
- [GitHub](https://github.com/zachhannum/mkdocs-tooltipster-links-plugin) (🔀 1 · 📦 28 · ⏱️ 29.07.2020)
- [PyPi](https://pypi.org/project/mkdocs-tooltipster-links-plugin) (📥 64 / month):
```
pip install mkdocs-tooltipster-links-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- tooltipster-links
```
ArgRef - 🥉7 · ⭐ 1 · ❗Unlicensed ·
mkdocs plugin to provides GitHub like autolink references in Mkdocs.
- [GitHub](https://github.com/rhshadrach/mkdocs-argref-plugin) (👨💻 5 · 🔀 1 · ⏱️ 25.08.2024)
- [PyPi](https://pypi.org/project/mkdocs-argref-plugin) (📥 450 / month):
```
pip install mkdocs-argref-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- argref
```
mkdocs-issues-plugin - 🥉6 · ⭐ 1 · 🐣 · MIT ·
A plugin for showing the state and labels of issues, PRs and discussions (GitHub or GitLab) in mkdocs generated docs.
- [GitHub](https://github.com/mihaigalos/mkdocs-issues-plugin) (👨💻 3 · 📦 1 · ⏱️ 24.07.2024)
- [PyPi](https://pypi.org/project/mkdocs-issues-plugin) (📥 300 / month):
```
pip install mkdocs-issues-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs-issues-plugin
```
MkDocs Backlinks Section Plugin - 🥉6 · 🐣 · MIT ·
Create a backlink section that lists every page linking to the current page.
- [GitHub](https://github.com/six-two/mkdocs-backlinks-section-plugin) (⏱️ 19.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-backlinks-section-plugin) (📥 900 / month):
```
pip install mkdocs-backlinks-section-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- backlinks_section
```
webcontext - 🥉5 · ⭐ 1 · 💤 · MIT ·
Mkdocs plugin for converting absolute paths to webcontext aware paths using the configured webcontext context.
- [GitHub](https://github.com/Darrelk/mkdocs-webcontext-plugin) (👨💻 2 · 🔀 1 · 📥 11 · 📦 6 · ⏱️ 25.05.2023)
- [PyPi](https://pypi.org/project/mkdocs-webcontext-plugin) (📥 67 / month):
```
pip install mkdocs-webcontext-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- webcontext
```
emailprotect - 🥉4 · ⭐ 5 · 💤 · MIT ·
A MkDocs plugin that tries to obscure email-addresses from address-harvesting spam-bots.
- [GitHub](https://github.com/rkoe/mkdocs-emailprotect) (⏱️ 21.01.2020)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- emailprotect
```
Mkdocs-Addresses - 🥉4 · 💤 · ❗Unlicensed ·
Mkdocs plugin, building automatically the appropriate relative paths (to images, links, anchors, ...) using..
- [PyPi](https://pypi.org/project/mkdocs-addresses) (📥 340 / month):
```
pip install mkdocs-addresses
```
- [GitLab](https://gitlab.com/frederic-zinelli/mkdocs-addresses) (🔀 0 · ⏱️ 13.07.2023)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs-addresses
```
alternate-link - 🥉3 · ⭐ 4 · 💤 · MIT ·
An MkDocs plugin that simplifies internal links creation.
- [GitHub](https://github.com/cmitu/mkdocs-altlink-plugin) (👨💻 3 · 🔀 2 · ⏱️ 14.02.2021)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- alternate-link
```
## 🧩 Markdown extensions
PyMdown Extensions - 🥇32 · ⭐ 980 · ❗Unlicensed ·
Extensions for Python Markdown.
- [GitHub](https://github.com/facelessuser/pymdown-extensions) (👨💻 49 · 🔀 260 · 📦 40K · 📋 390 - 2% open · ⏱️ 23.12.2024)
- [PyPi](https://pypi.org/project/pymdown-extensions) (📥 5.7M / month):
```
pip install pymdown-extensions
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- pymdownx.arithmatex
- pymdownx.b64
- pymdownx.betterem
- pymdownx.blocks.admonition
- pymdownx.blocks.definition
- pymdownx.blocks.details
- pymdownx.blocks.html
- pymdownx.blocks.tab
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji
- pymdownx.escapeall
- pymdownx.extra
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.pathconverter
- pymdownx.progressbar
- pymdownx.saneheaders
- pymdownx.smartsymbols
- pymdownx.snippets
- pymdownx.striphtml
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.tasklist
- pymdownx.tilde
```
mkdocs-callouts - 🥇19 · ⭐ 32 · MIT ·
A simple MkDocs plugin that converts Obsidian callout blocks to mkdocs supported Admonitions.
- [GitHub](https://github.com/sondregronas/mkdocs-callouts) (👨💻 2 · 🔀 2 · 📦 1.3K · ⏱️ 11.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-callouts) (📥 15K / month):
```
pip install mkdocs-callouts
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- callouts
```
markdown-callouts - 🥇18 · ⭐ 32 · MIT ·
Markdown extension: a classier syntax for admonitions.
- [GitHub](https://github.com/oprypin/markdown-callouts) (👨💻 2 · 🔀 14 · 📦 340 · 📋 12 - 33% open · ⏱️ 07.12.2024)
- [PyPi](https://pypi.org/project/markdown-callouts) (📥 47K / month):
```
pip install markdown-callouts
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- callouts
- github-callouts
```
YAML metadata - 🥈16 · ⭐ 23 · MIT ·
YAML metadata extension for Python-Markdown.
- [GitHub](https://github.com/sivakov512/python-markdown-full-yaml-metadata) (👨💻 7 · 🔀 4 · 📦 88 · 📋 10 - 30% open · ⏱️ 03.07.2024)
- [PyPi](https://pypi.org/project/markdown-full-yaml-metadata) (📥 1.7K / month):
```
pip install markdown-full-yaml-metadata
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- full_yaml_metadata
```
Math extension - 🥈15 · ⭐ 120 · 💤 · BSD-3 ·
Math extension for Python-Markdown.
- [GitHub](https://github.com/mitya57/python-markdown-math) (👨💻 8 · 🔀 25 · 📋 24 - 8% open · ⏱️ 12.08.2022)
- [PyPi](https://pypi.org/project/python-markdown-math) (📥 79K / month):
```
pip install python-markdown-math
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mdx_math
```
Mdx Truly Sane Lists - 🥈15 · ⭐ 89 · 💤 · MIT ·
Extension for Python-Markdown that makes lists truly sane. Custom indents for nested lists and fix for messy..
- [GitHub](https://github.com/radude/mdx_truly_sane_lists) (👨💻 4 · 🔀 10 · 📋 15 - 46% open · ⏱️ 19.07.2022)
- [PyPi](https://pypi.org/project/mdx-truly-sane-lists) (📥 540K / month):
```
pip install mdx-truly-sane-lists
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mdx_truly_sane_lists
```
Markdown Inline Graphviz - 🥈13 · ⭐ 5 · MIT ·
Render inline graphs with Markdown and Graphviz.
- [GitHub](https://github.com/cesaremorel/markdown-inline-graphviz) (👨💻 9 · 🔀 8 · 📋 8 - 12% open · ⏱️ 16.01.2024)
- [PyPi](https://pypi.org/project/markdown-inline-graphviz-extension) (📥 250K / month):
```
pip install markdown-inline-graphviz-extension
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- markdown_inline_graphviz
```
MarkdownSuperscript - 🥈12 · ⭐ 2 · 💤 · BSD-2 ·
An extension to the Python Markdown package enabling superscript text.
- [GitHub](https://github.com/jambonrose/markdown_superscript_extension) (👨💻 2 · 🔀 3 · 📦 47 · 📋 4 - 25% open · ⏱️ 02.12.2018)
- [PyPi](https://pypi.org/project/MarkdownSuperscript) (📥 1.2K / month):
```
pip install MarkdownSuperscript
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- superscript
```
Markdown Checklist - 🥈11 · ⭐ 80 · 💤 · MIT ·
Python Markdown extension for lists of tasks with checkboxes.
- [GitHub](https://github.com/FND/markdown-checklist) (👨💻 2 · 🔀 32 · 📋 8 - 12% open · ⏱️ 29.07.2022)
- [PyPi](https://pypi.org/project/markdown-checklist) (📥 2.4K / month):
```
pip install markdown-checklist
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- markdown_checklist.extension
```
MarkdownSubscript - 🥈11 · ⭐ 3 · 💤 · BSD-2 ·
An extension to the Python Markdown package enabling subscript text.
- [GitHub](https://github.com/jambonrose/markdown_subscript_extension) (👨💻 2 · 🔀 1 · 📦 59 · 📋 5 - 40% open · ⏱️ 02.12.2018)
- [PyPi](https://pypi.org/project/MarkdownSubscript) (📥 440 / month):
```
pip install MarkdownSubscript
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- subscript
```
Breakless Lists - 🥈10 · ⭐ 6 · 💤 · MIT ·
Python markdown breakless lists extension.
- [GitHub](https://github.com/adamb70/mdx-breakless-lists) (🔀 2 · 📋 2 - 50% open · ⏱️ 08.10.2020)
- [PyPi](https://pypi.org/project/mdx-breakless-lists) (📥 62K / month):
```
pip install mdx-breakless-lists
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mdx_breakless_lists
```
python-asciimathml - 🥉8 · ⭐ 4 · 💤 · ❗️GPL-3.0 ·
python ASCIIMathML to Presentation MathML translator.
- [GitHub](https://github.com/ShadowKyogre/python-asciimathml) (👨💻 8 · 🔀 4 · ⏱️ 04.04.2017)
- [PyPi](https://pypi.org/project/asciimathml) (📥 360 / month):
```
pip install asciimathml
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mdx_asciimathml
```
markdown-emdash - 🥉8 · ⭐ 3 · 💤 · MIT ·
Emdash extension for python-markdown.
- [GitHub](https://github.com/czue/markdown-emdash) (🔀 1 · 📦 35 · ⏱️ 18.05.2023)
- [PyPi](https://pypi.org/project/markdown-emdash) (📥 290 / month):
```
pip install markdown-emdash
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mdx_emdash
```
markdown-icons - 🥉7 · ⭐ 13 · 💤 · ❗Unlicensed ·
Easily display icon fonts in markdown.
- [GitHub](https://github.com/MadLittleMods/markdown-icons) (👨💻 4 · 🔀 12 · 📋 7 - 42% open · ⏱️ 09.12.2018)
- [PyPi](https://pypi.org/project/markdown-iconfonts) (📥 71 / month):
```
pip install markdown-iconfonts
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- iconfonts
```
markdown-katex - 🥉7 · ⭐ 11 · 💤 · ❗Unlicensed ·
KaTeX extension for Python Markdown.
- [PyPi](https://pypi.org/project/markdown-katex) (📥 11K / month):
```
pip install markdown-katex
```
- [GitLab](https://gitlab.com/mbarkhau/markdown-katex) (🔀 4 · 📋 17 - 23% open · ⏱️ 14.05.2019)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- markdown_katex
```
caption - 🥉7 · ⭐ 10 · 💤 · ❗️GPL-3.0 ·
- [GitHub](https://github.com/flywire/caption) (👨💻 3 · 🔀 2 · 📦 66 · 📋 8 - 87% open · ⏱️ 29.01.2023)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- caption
- image_captions
- table_captions
```
mkpatcher - 🥉7 · ⭐ 2 · 💤 · Apache-2 ·
Python-Markdown extension allowing arbitrary scripts to modify MkDocs input files.
- [GitHub](https://github.com/ofek/mkpatcher) (📦 8 · ⏱️ 26.04.2020)
- [PyPi](https://pypi.org/project/mkpatcher) (📥 460 / month):
```
pip install mkpatcher
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mkpatcher
```
Tweetable quotes - 🥉6 · ⭐ 15 · 💤 · MIT ·
Python-Markdown extension to embed tweetable quotes into your blog posts.
- [GitHub](https://github.com/max-arnold/markdown-tweetable) (🔀 1 · 📦 5 · ⏱️ 25.03.2019)
- [PyPi](https://pypi.org/project/markdown-tweetable) (📥 110 / month):
```
pip install markdown-tweetable
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- tweetable.extension
```
HEARTBEATS Flavored Markdown - 🥉6 · ⭐ 14 · 💤 · ❗Unlicensed ·
HEARTBEATS Flavored Markdown extension.
- [GitHub](https://github.com/heartbeatsjp/markdown-extension-hbfm) (👨💻 2 · 🔀 1 · 📦 10 · ⏱️ 01.03.2018)
- [PyPi](https://pypi.org/project/hbfm) (📥 310 / month):
```
pip install hbfm
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- hbfm.inline_coloring
- hbfm.inline_list
- hbfm.number_headers
- hbfm.quote_uri_hash
```
KBD Extension - 🥉6 · ⭐ 2 · 💤 · MIT ·
KBD Extension for Python-Markdown.
- [GitHub](https://github.com/RickTalken/kbdextension) (🔀 1 · 📦 11 · ⏱️ 08.06.2020)
- [PyPi](https://pypi.org/project/kbdextension) (📥 990 / month):
```
pip install kbdextension
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- kbdextension
```
Cite Extension - 🥉5 · ⭐ 6 · 💤 · ❗Unlicensed ·
Python-Markdown extension to support the cite tag.
- [GitHub](https://github.com/aleray/mdx_cite) (🔀 3 · ⏱️ 21.04.2012)
- [PyPi](https://pypi.org/project/mdx-cite) (📥 23 / month):
```
pip install mdx-cite
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mdx_cite
```
Markdown Grid Tables - 🥉5 · ⭐ 1 · 💤 · ❗Unlicensed ·
[Python-Markdown](https://python-markdown.github.io/) [extension](https://python-markdown.github.io/extensions/api/)..
- [PyPi](https://pypi.org/project/markdown-grid-tables) (📥 5.8K / month):
```
pip install markdown-grid-tables
```
- [GitLab](https://gitlab.com/WillDaSilva/markdown_grid_tables) (🔀 4 · ⏱️ 09.02.2022)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- markdown_grid_tables
```
Markdown PyCon - 🥉5 · ⭐ 1 · ISC ·
Markdown extension to parse `pycon` code blocks without indentation or fences.
- [GitHub](https://github.com/pawamoy/markdown-pycon) (📦 2 · ⏱️ 25.12.2024)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- pycon
```
markdown_sub_sup - 🥉4 · ⭐ 1 · 💤 · ❗️LGPL-3.0 ·
A python markdown extension for add sub and sup support.
- [GitHub](https://github.com/alberic89/markdown_sub_sup) (⏱️ 24.03.2023)
- [PyPi](https://pypi.org/project/markdown-sub-sup) (📥 88 / month):
```
pip install markdown-sub-sup
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- markdown_sub_sup
```
markdown-del-ins - 🥉3 · ⭐ 12 · 💤 · ❗Unlicensed ·
Markdown extension to support the del and ins tags.
- [GitHub](https://github.com/honzajavorek/markdown-del-ins) (👨💻 2 · ⏱️ 09.01.2020)
- [PyPi](https://pypi.org/project/markdown-del-ins) (📥 940 / month):
```
pip install markdown-del-ins
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- markdown_del_ins
```
Semantic WikiLinks Extension - 🥉3 · ⭐ 8 · 💤 · ❗Unlicensed ·
Python-Markdown extension to add support for semantic (wiki)links (RDFa).
- [GitHub](https://github.com/aleray/mdx_semanticwikilinks) (🔀 1 · ⏱️ 15.08.2012)
- [PyPi](https://pypi.org/project/mdx-semanticwikilinks) (📥 53 / month):
```
pip install mdx-semanticwikilinks
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mdx_semanticwikilinks
```
Semantic Data Extension - 🥉3 · ⭐ 5 · 💤 · ❗Unlicensed ·
Python-Markdown extension to add support for semantic data (RDFa).
- [GitHub](https://github.com/aleray/mdx_semanticdata) (🔀 1 · ⏱️ 05.11.2012)
- [PyPi](https://pypi.org/project/mdx-semanticdata) (📥 39 / month):
```
pip install mdx-semanticdata
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mdx_semanticdata
```
Django Static Image · ❗Unlicensed ·
- [PyPi](https://pypi.org/project/markdown-djangostaticimage) (📥 20 / month):
```
pip install markdown-djangostaticimage
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- django_static_image
```
## 🧭 Navigation & page building
awesome-pages - 🥇26 · ⭐ 500 · MIT ·
An MkDocs plugin that simplifies configuring page titles and their order.
- [GitHub](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin) (👨💻 9 · 🔀 38 · 📦 5K · 📋 90 - 25% open · ⏱️ 22.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-awesome-pages-plugin) (📥 440K / month):
```
pip install mkdocs-awesome-pages-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- awesome-pages
```
encryptcontent - 🥇20 · ⭐ 130 · MIT ·
A MkDocs plugin that encrypt/decrypt markdown content with AES.
- [GitHub](https://github.com/unverbuggt/mkdocs-encryptcontent-plugin) (👨💻 6 · 🔀 16 · 📥 97 · 📦 1.2K · 📋 68 - 7% open · ⏱️ 27.10.2024)
- [PyPi](https://pypi.org/project/mkdocs-encryptcontent-plugin) (📥 6.9K / month):
```
pip install mkdocs-encryptcontent-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- encryptcontent
```
section-index - 🥇20 · ⭐ 81 · MIT ·
MkDocs plugin to allow clickable sections that lead to an index page.
- [GitHub](https://github.com/oprypin/mkdocs-section-index) (👨💻 3 · 🔀 8 · 📦 2K · 📋 22 - 36% open · ⏱️ 07.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-section-index) (📥 200K / month):
```
pip install mkdocs-section-index
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- section-index
```
literate-nav - 🥇20 · ⭐ 79 · MIT ·
MkDocs plugin to specify the navigation in Markdown instead of YAML.
- [GitHub](https://github.com/oprypin/mkdocs-literate-nav) (🔀 8 · 📦 2.2K · 📋 30 - 46% open · ⏱️ 07.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-literate-nav) (📥 260K / month):
```
pip install mkdocs-literate-nav
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- literate-nav
```
mkdocs-simple-hooks - 🥈18 · ⭐ 60 · 💤 · MIT ·
Define your own hooks for mkdocs, without having to create a new package.
- [GitHub](https://github.com/aklajnert/mkdocs-simple-hooks) (👨💻 6 · 🔀 5 · 📥 60 · 📦 1.9K · ⏱️ 14.11.2023)
- [PyPi](https://pypi.org/project/mkdocs-simple-hooks) (📥 37K / month):
```
pip install mkdocs-simple-hooks
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs-simple-hooks
```
exclude - 🥈17 · ⭐ 87 · 💤 · Apache-2 ·
A mkdocs plugin that lets you exclude files or trees from your output.
- [GitHub](https://github.com/apenwarr/mkdocs-exclude) (🔀 10 · 📦 2.3K · 📋 12 - 75% open · ⏱️ 20.02.2019)
- [PyPi](https://pypi.org/project/mkdocs-exclude) (📥 140K / month):
```
pip install mkdocs-exclude
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- exclude
```
Publisher for MkDocs - meta - 🥈16 · ⭐ 72 · MIT ·
Automatic navigation based on files metadata with URL name and publication status control.
- [GitHub](https://github.com/mkdocs-publisher/mkdocs-publisher) (👨💻 2 · 🔀 3 · 📥 59 · 📦 66 · 📋 23 - 26% open · ⏱️ 05.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-publisher) (📥 2.3K / month):
```
pip install mkdocs-publisher
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- pub-meta
```
mkdocs-gallery - 🥈16 · ⭐ 42 · 📈 · BSD-3 ·
Same features as sphinx-gallery (https://sphinx-gallery.github.io/) but on mkdocs (https://www.mkdocs.org/) (no sphinx..
- [GitHub](https://github.com/smarie/mkdocs-gallery) (👨💻 10 · 🔀 16 · 📋 72 - 38% open · ⏱️ 30.09.2024)
- [PyPi](https://pypi.org/project/mkdocs-gallery) (📥 4.8K / month):
```
pip install mkdocs-gallery
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- gallery
```
file-filter - 🥈14 · ⭐ 10 · MIT ·
A MkDocs plugin that lets you exclude/include docs files using globs, regexes, gitignore-style file and..
- [GitHub](https://github.com/DariuszPorowski/mkdocs-file-filter-plugin) (👨💻 4 · 🔀 3 · 📥 99 · 📦 15 · 📋 12 - 33% open · ⏱️ 19.07.2024)
- [PyPi](https://pypi.org/project/mkdocs-file-filter-plugin) (📥 5.1K / month):
```
pip install mkdocs-file-filter-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- file-filter
```
mkdocs-pagetree-plugin - 🥈14 · ⭐ 4 · MIT ·
MkDocs plugin that allows you to display the page tree. Like `sitemap.xml`, but for humans.
- [GitHub](https://github.com/tombreit/mkdocs-pagetree-plugin) (👨💻 2 · 🔀 1 · 📦 11 · 📋 10 - 20% open · ⏱️ 29.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-pagetree-plugin) (📥 18K / month):
```
pip install mkdocs-pagetree-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- pagetree
```
mkdocs-live-edit-plugin - 🥈13 · ⭐ 19 · MIT ·
An MkDocs plugin that allows editing pages directly from the browser.
- [GitHub](https://github.com/EddyLuten/mkdocs-live-edit-plugin) (👨💻 3 · 🔀 3 · 📦 9 · 📋 6 - 33% open · ⏱️ 15.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-live-edit-plugin) (📥 460 / month):
```
pip install mkdocs-live-edit-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- live-edit
```
mkdocs-nav-weight - 🥉12 · ⭐ 10 · MIT ·
A simple mkdocs plugin, enables to organize Navigation in a more markdownic way.
- [GitHub](https://github.com/shu307/mkdocs-nav-weight) (👨💻 3 · 🔀 2 · 📦 85 · ⏱️ 26.10.2024)
- [PyPi](https://pypi.org/project/mkdocs-nav-weight) (📥 19K / month):
```
pip install mkdocs-nav-weight
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs-nav-weight
```
toc-sidebar - 🥉11 · ⭐ 5 · 💤 · MIT ·
An MkDocs plugin that allows users to add additional content to the ToC sidebar using the Material theme.
- [GitHub](https://github.com/zachhannum/mkdocs-toc-sidebar-plugin) (👨💻 2 · 🔀 3 · 📦 42 · ⏱️ 11.01.2020)
- [PyPi](https://pypi.org/project/mkdocs-toc-sidebar-plugin) (📥 50K / month):
```
pip install mkdocs-toc-sidebar-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- toc-sidebar
```
MkRefs - 🥉10 · ⭐ 34 · 💤 · MIT ·
MkDocs plugin to generate semantic reference Markdown pages from a knowledge graph.
- [GitHub](https://github.com/DerwenAI/mkrefs) (👨💻 2 · 📦 5 · ⏱️ 31.08.2023)
- [PyPi](https://pypi.org/project/mkrefs) (📥 100 / month):
```
pip install mkrefs
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkrefs
```
include directory to navigation - 🥉9 · ⭐ 28 · 💤 · ❗Unlicensed ·
Simple MKDocs plugin than permit to fetch and replace directory in navigation.
- [GitHub](https://github.com/mysiki/mkdocs_include_dir_to_nav) (🔀 2 · 📥 15 · 📋 4 - 50% open · ⏱️ 01.03.2022)
- [PyPi](https://pypi.org/project/mkdocs-include-dir-to-nav) (📥 110K / month):
```
pip install mkdocs-include-dir-to-nav
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- include_dir_to_nav
```
mkdocs-categories-plugin - 🥉9 · ⭐ 15 · MIT ·
An MkDocs plugin allowing for categorization of wiki pages.
- [GitHub](https://github.com/EddyLuten/mkdocs-categories-plugin) (📦 18 · ⏱️ 22.04.2024)
- [PyPi](https://pypi.org/project/mkdocs-categories-plugin) (📥 760 / month):
```
pip install mkdocs-categories-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- categories
```
vim-md-tags - 🥉9 · ⭐ 6 · 💤 · MIT ·
An MkDocs plugin that creates a vim tag file of all markdown files.
- [GitHub](https://github.com/zachhannum/mkdocs-vim-md-tags-plugin) (👨💻 4 · 🔀 1 · 📦 12 · ⏱️ 08.05.2020)
- [PyPi](https://pypi.org/project/mkdocs-vim-md-tags-plugin) (📥 86 / month):
```
pip install mkdocs-vim-md-tags-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- vim-md-tags
```
mkdocs-nav-enhancements - 🥉9 · ⭐ 3 · 💤 · MIT ·
WIP plugin for working with titles of pages in MkDocs.
- [GitHub](https://github.com/Rylon/mkdocs-nav-enhancements) (📦 35 · ⏱️ 24.07.2019)
- [PyPi](https://pypi.org/project/mkdocs-nav-enhancements) (📥 3.4K / month):
```
pip install mkdocs-nav-enhancements
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs-nav-enhancements
```
mkdocs-breadcrumbs-plugin - 🥉8 · ⭐ 1 · MIT ·
Location-based breadcrumbs navigation.
- [GitHub](https://github.com/mihaigalos/mkdocs-breadcrumbs-plugin) (👨💻 4 · 📦 5 · ⏱️ 06.09.2024)
- [PyPi](https://pypi.org/project/mkdocs-breadcrumbs-plugin) (📥 1.2K / month):
```
pip install mkdocs-breadcrumbs-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs-breadcrumbs-plugin
```
schema-reader - 🥉7 · ⭐ 3 · 💤 · MIT ·
A mkdocs plugin that scans specified directories and files for JSON Schema files, converts them to markdown and builds..
- [GitHub](https://github.com/magicaljellybeans/mkdocs_schema_reader) (👨💻 3 · 🔀 3 · 📋 3 - 66% open · ⏱️ 23.06.2021)
- [PyPi](https://pypi.org/project/mkdocs-schema-reader) (📥 1.2K / month):
```
pip install mkdocs-schema-reader
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- schema_reader
```
SWAN Gallery - 🥉7 · ⭐ 1 · 💤 · ❗️AGPL-3.0 ·
MkDocs plugin to generate a SWAN Gallery.
- [GitHub](https://github.com/swan-cern/mkdocs-swangallery) (👨💻 2 · 📦 3 · ⏱️ 20.07.2023)
- [PyPi](https://pypi.org/project/mkdocs-swangallery) (📥 160 / month):
```
pip install mkdocs-swangallery
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- swangallery
```
select-files - 🥉6 · 💤 · Apache-2 ·
Filter pages for assignments.
- [GitHub](https://github.com/supcik/mkdocs-select-files) (📦 9 · ⏱️ 05.09.2019)
- [PyPi](https://pypi.org/project/mkdocs-select-files) (📥 80 / month):
```
pip install mkdocs-select-files
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- select-files
```
MkDocs Remove Sections Plugin - 🥉6 · 🐣 · MIT ·
Remove sections with specific titles from your MkDocs pages.
- [GitHub](https://github.com/six-two/mkdocs-remove-sections-plugin) (⏱️ 12.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-remove-sections-plugin) (📥 660 / month):
```
pip install mkdocs-remove-sections-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- remove_sections
```
mkdocs-title-casing-plugin - 🥉5 · ⭐ 2 · 💤 · ❗️GPL-3.0 ·
A lightweight mkdocs plugin to add title casing to all mkdocs pages and sections.
- [GitHub](https://github.com/mattchristopher314/mkdocs-title-casing-plugin) (📦 3 · ⏱️ 02.09.2023)
- [PyPi](https://pypi.org/project/mkdocs-title-casing-plugin) (📥 990 / month):
```
pip install mkdocs-title-casing-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- title-casing
```
awesome-list - 🥉4 · ⭐ 5 · 💤 · MIT ·
MkDocs Plugin to inject social media cards for each entry in an awesome-list.
- [GitHub](https://github.com/carlosperate/mkdocs-awesome-list-plugin) (⏱️ 26.07.2019)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- awesome-list
```
pagenav-generator - 🥉2 · ⭐ 4 · 💤 · MIT ·
Little something to automatically generate a Navigation within a page itself. Depends on Awesome-pages.
- [GitHub](https://github.com/Andre601/mkdocs-pagenav-generator) (👨💻 2 · 🔀 1 · ⏱️ 17.04.2022)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- pagenav-generator
```
mkdocs-pug - 🥉2 · 💤 · ❗Unlicensed
Use pug templates with your mkdocs template.
- [GitHub](https://github.com/vzhong/mkdocs_pug) (⏱️ 20.10.2021)
- [PyPi](https://pypi.org/project/mkdocs-pug) (📥 33 / month):
```
pip install mkdocs-pug
```
## ✅ Quality checks (code blocks, spelling, etc.)
mktestdocs - 🥇17 · ⭐ 110 · 📉 · Apache-2
Run pytest against markdown files/docstrings.
- [GitHub](https://github.com/koaning/mktestdocs) (👨💻 5 · 🔀 9 · 📦 66 · 📋 7 - 28% open · ⏱️ 24.10.2024)
- [PyPi](https://pypi.org/project/mktestdocs) (📥 3.8K / month):
```
pip install mktestdocs
```
mkdocs-spellcheck - 🥇17 · ⭐ 18 · ISC ·
A spell checker plugin for MkDocs.
- [GitHub](https://github.com/pawamoy/mkdocs-spellcheck) (👨💻 4 · 🔀 4 · 📦 61 · 📋 21 - 38% open · ⏱️ 03.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-spellcheck) (📥 13K / month):
```
pip install mkdocs-spellcheck
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- spellcheck
```
Link Checker - 🥈9 · ⭐ 10 · 💤 · MIT
Python asyncio + aiohttp Markdown *.md URL link checker: 10,000 files/second.
- [GitHub](https://github.com/byrnereese/linkchecker-mkdocs) (👨💻 5 · 🔀 5 · ⏱️ 24.08.2021)
- [PyPi](https://pypi.org/project/mkdocs-linkcheck) (📥 5K / month):
```
pip install mkdocs-linkcheck
```
mkdocs-code-validator - 🥈9 · ⭐ 2 · MIT ·
Checks Markdown code blocks in a MkDocs site against user-defined actions.
- [GitHub](https://github.com/oprypin/mkdocs-code-validator) (📦 16 · ⏱️ 07.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-code-validator) (📥 280 / month):
```
pip install mkdocs-code-validator
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- code-validator
```
mkdocs-codecheck - 🥉6 · ⭐ 2 · 💤 · MIT
Traverses a directory tree looking for code samples, then attempts to validate each code sample found.
- [GitHub](https://github.com/byrnereese/codechecker-mkdocs) (👨💻 6 · ⏱️ 16.12.2021)
- [PyPi](https://pypi.org/project/mkdocs-codecheck) (📥 120 / month):
```
pip install mkdocs-codecheck
```
MkDocs-Test - 🥉5 · ⭐ 3 · 🐣 · MIT ·
A framework for testing MkDocs projects.
- [GitHub](https://github.com/fralau/mkdocs-test) (⏱️ 04.11.2024)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- test
```
## 🔍 Search & tables of content
exclude-search - 🥇17 · ⭐ 27 · 💤 · MIT ·
A mkdocs plugin that excludes selected chapters from the docs search index.
- [GitHub](https://github.com/chrieke/mkdocs-exclude-search) (👨💻 6 · 🔀 2 · 📥 16 · 📦 440 · ⏱️ 04.12.2023)
- [PyPi](https://pypi.org/project/mkdocs-exclude-search) (📥 26K / month):
```
pip install mkdocs-exclude-search
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- exclude-search
```
localsearch - 🥈16 · ⭐ 33 · 💤 · MIT ·
A MkDocs plugin to make the native search plugin work locally (file:// protocol).
- [GitHub](https://github.com/wilhelmer/mkdocs-localsearch) (👨💻 6 · 🔀 7 · 📦 88 · ⏱️ 02.01.2023)
- [PyPi](https://pypi.org/project/mkdocs-localsearch) (📥 4.2K / month):
```
pip install mkdocs-localsearch
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- localsearch
```
tags - 🥉9 · ⭐ 43 · 💤 · MIT ·
Processes tags in yaml metadata.
- [GitHub](https://github.com/jldiaz/mkdocs-plugin-tags) (👨💻 3 · 🔀 19 · 📋 14 - 42% open · ⏱️ 02.09.2021)
- [PyPi](https://pypi.org/project/mkdocs-plugin-tags) (📥 740 / month):
```
pip install mkdocs-plugin-tags
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- tags
```
extract listings - 🥉8 · ⭐ 2 · MIT ·
Generate a page with all listings and/or a search page for listings.
- [GitHub](https://github.com/six-two/mkdocs-extract-listings-plugin) (⏱️ 23.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-extract-listings-plugin) (📥 2.2K / month):
```
pip install mkdocs-extract-listings-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- extract_listings
```
mkdocs-task-collector - 🥉6 · ⭐ 2 · 🐣 · MIT ·
mkdocs plugin to generate a comprehensive and organized task list, making it easier to manage and track tasks, notes,..
- [GitHub](https://github.com/costantinoai/mkdocs-task-collector) (📦 2 · ⏱️ 11.08.2024)
- [PyPi](https://pypi.org/project/mkdocs-task-collector) (📥 1K / month):
```
pip install mkdocs-task-collector
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- task-collector
```
## 🍱 Site conversion (PDF/ePUB/etc.)
print-site - 🥇23 · ⭐ 150 · MIT ·
MkDocs Plugin that adds an additional page that combines all pages, allowing easy exports to PDF and standalone HTML.
- [GitHub](https://github.com/timvink/mkdocs-print-site-plugin) (👨💻 11 · 🔀 23 · 📦 380 · 📋 100 - 17% open · ⏱️ 12.09.2024)
- [PyPi](https://pypi.org/project/mkdocs-print-site-plugin) (📥 30K / month):
```
pip install mkdocs-print-site-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- print-site
```
mkdocs-with-pdf - 🥇22 · ⭐ 340 · 💤 · MIT ·
Generate a single PDF file from MkDocs repository.
- [GitHub](https://github.com/orzih/mkdocs-with-pdf) (👨💻 6 · 🔀 74 · 📦 650 · 📋 110 - 57% open · ⏱️ 14.10.2021)
- [PyPi](https://pypi.org/project/mkdocs-with-pdf) (📥 59K / month):
```
pip install mkdocs-with-pdf
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- with-pdf
```
pdf-export - 🥇22 · ⭐ 320 · 💤 · MIT ·
An MkDocs plugin to export content pages as PDF files.
- [GitHub](https://github.com/zhaoterryy/mkdocs-pdf-export-plugin) (👨💻 11 · 🔀 42 · 📦 1.2K · 📋 89 - 48% open · ⏱️ 05.10.2021)
- [PyPi](https://pypi.org/project/mkdocs-pdf-export-plugin) (📥 27K / month):
```
pip install mkdocs-pdf-export-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- pdf-export
```
mkpdfs - 🥈17 · ⭐ 100 · 💤 · ❗️GPL-3.0 ·
Converts your mkdocs documentation in PDF, to be shared with users.
- [GitHub](https://github.com/comwes/mkpdfs-mkdocs-plugin) (👨💻 8 · 🔀 30 · 📥 41 · 📦 62 · 📋 39 - 30% open · ⏱️ 11.08.2021)
- [PyPi](https://pypi.org/project/mkpdfs-mkdocs) (📥 3.1K / month):
```
pip install mkpdfs-mkdocs
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkpdfs
```
mkdocs-exporter - 🥈17 · ⭐ 84 · MIT ·
The fastest and most configurable plugin for MkDocs, allowing seamless export of individual pages and/or entire..
- [GitHub](https://github.com/adrienbrignon/mkdocs-exporter) (👨💻 4 · 🔀 8 · 📦 11 · 📋 53 - 47% open · ⏱️ 29.10.2024)
- [PyPi](https://pypi.org/project/mkdocs-exporter) (📥 6K / month):
```
pip install mkdocs-exporter
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- exporter
```
mkdocs-pandoc - 🥉14 · ⭐ 110 · 💤 · Apache-2
[unmaintained] mkdocs - pandoc converter: use this fork https://github.com/twardoch/mkdocs-combine.
- [GitHub](https://github.com/jgrassler/mkdocs-pandoc) (👨💻 4 · 🔀 22 · 📦 54 · 📋 23 - 56% open · ⏱️ 14.03.2016)
- [PyPi](https://pypi.org/project/mkdocs-pandoc) (📥 370 / month):
```
pip install mkdocs-pandoc
```
pdf-with-js - 🥉13 · ⭐ 8 · 💤 · MIT ·
A MkDocs plugin that exports your documentation as PDF with rendered JavaScript content.
- [GitHub](https://github.com/smaxtec/mkdocs-pdf-with-js-plugin) (👨💻 4 · 🔀 3 · 📦 13 · ⏱️ 23.07.2021)
- [PyPi](https://pypi.org/project/mkdocs-pdf-with-js-plugin) (📥 1.5K / month):
```
pip install mkdocs-pdf-with-js-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- pdf-with-js
```
mk2pdf-export - 🥉7 · ⭐ 10 · 💤 · MIT ·
The plugin is based on https://github.com/zhaoterryy/mkdocs-pdf-export-plugin/ ,the main change is use pandoc to..
- [GitHub](https://github.com/HaoLiuHust/mkdocs-mk2pdf-plugin) (👨💻 4 · 🔀 5 · 📦 3 · ⏱️ 11.09.2020)
- [PyPi](https://pypi.org/project/mkdocs-mk2pdf-plugin) (📥 58 / month):
```
pip install mkdocs-mk2pdf-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mk2pdf-export
```
mkdocs-zip-folders - 🥉7 · ⭐ 3 · 💤 · MIT ·
MkDocs plugin to zip configured folders and add them to the site.
- [GitHub](https://github.com/JakubAndrysek/mkdocs-zip-folders) (🔀 1 · ⏱️ 09.07.2023)
- [PyPi](https://pypi.org/project/mkdocs-zip-folders) (📥 370 / month):
```
pip install mkdocs-zip-folders
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- zip_folders
```
helm - 🥉3 · ⭐ 1 · 💤 · Apache-2 ·
An mkdocs plugin that turns docs website into helm repository.
- [GitHub](https://github.com/M00nF1sh/mkdocs-helm) (🔀 1 · ⏱️ 21.11.2018)
- [PyPi](https://pypi.org/project/mkdocs-helm) (📥 65 / month):
```
pip install mkdocs-helm
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- helm-repo
```
mkdocs-autozip - 🥉1 · ⭐ 2 · 💤 · ❗Unlicensed ·
A mkdocs plugin for auto zipping the document source.
- [GitHub](https://github.com/martinohanlon/mkdocs_autozip) (⏱️ 05.10.2022)
- [PyPi](https://pypi.org/project/mkdocs-autozip) (📥 150 / month):
```
pip install mkdocs-autozip
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- autozip
```
## 🔧 Site building, site management
mike - 🥇26 · ⭐ 570 · BSD-3 ·
Manage multiple versions of your MkDocs-powered documentation via Git.
- [GitHub](https://github.com/jimporter/mike) (👨💻 9 · 🔀 47 · 📥 360 · 📦 3.7K · 📋 180 - 5% open · ⏱️ 13.08.2024)
- [PyPi](https://pypi.org/project/mike) (📥 380K / month):
```
pip install mike
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mike
```
monorepo - 🥇22 · ⭐ 330 · Apache-2 ·
Build multiple documentation folders in a single Mkdocs. Designed for large codebases.
- [GitHub](https://github.com/backstage/mkdocs-monorepo-plugin) (👨💻 30 · 🔀 72 · 📦 500 · 📋 67 - 55% open · ⏱️ 04.01.2024)
- [PyPi](https://pypi.org/project/mkdocs-monorepo-plugin) (📥 440K / month):
```
pip install mkdocs-monorepo-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- monorepo
```
mkdocs-multirepo-plugin - 🥇22 · ⭐ 140 · MIT ·
Build documentation in multiple repos into one site.
- [GitHub](https://github.com/jdoiro3/mkdocs-multirepo-plugin) (👨💻 17 · 🔀 48 · 📦 170 · 📋 110 - 52% open · ⏱️ 13.08.2024)
- [PyPi](https://pypi.org/project/mkdocs-multirepo-plugin) (📥 69K / month):
```
pip install mkdocs-multirepo-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- multirepo
```
techdocs-core - 🥇22 · ⭐ 91 · Apache-2 ·
The core MkDocs plugin used by Backstages TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown..
- [GitHub](https://github.com/backstage/mkdocs-techdocs-core) (👨💻 45 · 🔀 64 · 📦 78 · 📋 67 - 7% open · ⏱️ 28.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-techdocs-core) (📥 360K / month):
```
pip install mkdocs-techdocs-core
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- techdocs-core
```
simple - 🥈20 · ⭐ 42 · Apache-2 ·
Build documentation files inside your code into a MkDocs site.
- [GitHub](https://github.com/athackst/mkdocs-simple-plugin) (👨💻 8 · 🔀 10 · 📦 55 · 📋 19 - 5% open · ⏱️ 29.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-simple-plugin) (📥 19K / month):
```
pip install mkdocs-simple-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- simple
```
mkdocs-versioning - 🥈17 · ⭐ 40 · 💤 · MIT ·
A tool that allows for versioning sites built with mkdocs.
- [GitHub](https://github.com/zayd62/mkdocs-versioning) (👨💻 5 · 🔀 6 · 📦 110 · 📋 25 - 12% open · ⏱️ 01.08.2021)
- [PyPi](https://pypi.org/project/mkdocs-versioning) (📥 2.6K / month):
```
pip install mkdocs-versioning
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs-versioning
```
markdown-docs - 🥈17 · ⭐ 21 · MIT ·
Action/docker image that transforms your markdown into a static website. No need for particular configuration: it just..
- [GitHub](https://github.com/ldeluigi/markdown-docs) (👨💻 4 · 🔀 5 · 📦 81 · ⏱️ 23.12.2024)
- [Docker Hub](https://hub.docker.com/r/deloo/markdown-docs) (📥 30K · ⏱️ 01.01.2025):
```
docker pull deloo/markdown-docs
```
Publisher for MkDocs - debugger - 🥈16 · ⭐ 72 · MIT ·
Advanced console and file logger from build and serve process.
- [GitHub](https://github.com/mkdocs-publisher/mkdocs-publisher) (👨💻 2 · 🔀 3 · 📥 59 · 📦 66 · 📋 23 - 26% open · ⏱️ 05.11.2024)
- [PyPi](https://pypi.org/project/mkdocs-publisher) (📥 2.3K / month):
```
pip install mkdocs-publisher
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- pub-debugger
```
same-dir - 🥈14 · ⭐ 42 · MIT ·
MkDocs plugin to allow placing mkdocs.yml in the same directory as documentation.
- [GitHub](https://github.com/oprypin/mkdocs-same-dir) (👨💻 2 · 🔀 2 · 📦 380 · 📋 8 - 12% open · ⏱️ 07.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-same-dir) (📥 21K / month):
```
pip install mkdocs-same-dir
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- same-dir
```
MkDocs Merge - 🥉13 · ⭐ 24 · MIT
Merge the source of multiple MkDocs sites into a single one.
- [GitHub](https://github.com/ovasquez/mkdocs-merge) (👨💻 3 · 🔀 6 · 📦 6 · 📋 9 - 55% open · ⏱️ 31.07.2024)
- [PyPi](https://pypi.org/project/mkdocs-merge) (📥 1.8K / month):
```
pip install mkdocs-merge
```
multirepo - 🥉11 · ⭐ 40 · MIT
A bit like monorepo, but keeps MkDocs projects separate.
- [GitHub](https://github.com/wilhelmer/mkdocs-multirepo) (👨💻 3 · 🔀 2 · 📦 2 · ⏱️ 04.01.2024)
- [PyPi](https://pypi.org/project/mkdocs-multirepo) (📥 720 / month):
```
pip install mkdocs-multirepo
```
mkdocs-exclude-unused-files - 🥉11 · ⭐ 4 · MIT ·
Exclude orphaned (unused) static files from your mkdocs build.
- [GitHub](https://github.com/JonasDoesThings/mkdocs-exclude-unused-files) (👨💻 3 · 🔀 2 · 📥 4 · 📦 18 · 📋 3 - 33% open · ⏱️ 09.06.2024)
- [PyPi](https://pypi.org/project/mkdocs-exclude-unused-files) (📥 1.2K / month):
```
pip install mkdocs-exclude-unused-files
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- exclude-unused-files
```
mkdocs-yamp - 🥉8 · ⭐ 2 · 💤 · Apache-2 ·
Yet Another Multirepo Plugin for MkDocs.
- [GitHub](https://github.com/boozallen/mkdocs-yamp-plugin) (👨💻 2 · 🔀 4 · 📦 7 · ⏱️ 10.10.2022)
- [PyPi](https://pypi.org/project/mkdocs-yamp) (📥 130 / month):
```
pip install mkdocs-yamp
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- yamp
```
mkdocs-exclude-tagged-files - 🥉7 · ⭐ 3 · 💤 · MIT ·
A mkdocs plugin for excluding files based on frontmatter tags.
- [GitHub](https://github.com/JonasDoesThings/mkdocs-exclude-tagged-files) (👨💻 2 · 🔀 2 · 📦 4 · ⏱️ 10.09.2023)
- [PyPi](https://pypi.org/project/mkdocs-exclude-tagged-files) (📥 230 / month):
```
pip install mkdocs-exclude-tagged-files
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs_exclude_tagged_files
```
no-sitemap - 🥉7 · ⭐ 1 · 💤 · MIT ·
Disable Mkdocs sitemap generation.
- [GitHub](https://github.com/leonardehrenfried/mkdocs-no-sitemap-plugin) (📦 19 · ⏱️ 04.04.2023)
- [PyPi](https://pypi.org/project/mkdocs-no-sitemap-plugin) (📥 2K / month):
```
pip install mkdocs-no-sitemap-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- no-sitemap
```
mkdocs-required-frontmatter-plugin - 🥉7 · MIT ·
This MkDocs plugin enforces required frontmatter for documentation pages.
- [GitHub](https://github.com/unmc-vcr/mkdocs-required-frontmatter-plugin) (📦 2 · ⏱️ 22.03.2024)
- [PyPi](https://pypi.org/project/mkdocs-required-frontmatter-plugin) (📥 52 / month):
```
pip install mkdocs-required-frontmatter-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- required-frontmatter
```
mkdocs-auto-refresh-build-pages - 🥉7 · MIT ·
MkDocs plugin that automatically refreshes the build pages when the documentation is updated.
- [GitHub](https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages) (📦 4 · ⏱️ 02.07.2024)
- [PyPi](https://pypi.org/project/mkdocs-auto-refresh-build-pages) (📥 92 / month):
```
pip install mkdocs-auto-refresh-build-pages
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- auto-refresh-build-pages
```
progress - 🥉6 · ⭐ 5 · 💤 · Apache-2 ·
A plugin for MkDocs that lets you know exactly what is happening during the build.
- [GitHub](https://github.com/rdilweb/mkdocs-plugin-progress) (👨💻 3 · 📦 37 · ⏱️ 20.06.2020)
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- progress
```
mkdocs-new-features-notifier - 🥉3 · ⭐ 3 · 💤 · MIT ·
This plugin enables you to notify users of new features in your product. It does this by identifying new documentation..
- [GitHub](https://github.com/kevin-411/mkdocs-new-features-notifier) (👨💻 2 · 🔀 1 · ⏱️ 15.01.2020)
- [PyPi](https://pypi.org/project/mkdocs-new-features-notifier):
```
pip install mkdocs-new-features-notifier
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- mkdocs-new-features-notifier
```
multiple - 🥉3 · ⭐ 1 · 💤 · ❗️GPL-3.0 ·
Allows to merge mkdocs documentations dynamically.
- [GitHub](https://github.com/experimaestro/mkdocs-multiple) (👨💻 2 · ⏱️ 22.11.2019)
- [PyPi](https://pypi.org/project/mkdocs-multiple) (📥 1K / month):
```
pip install mkdocs-multiple
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- multiple
```
octadocs-adr - 🥉3 · ⭐ 1 · 💤 · ❗Unlicensed ·
A blueprint for Architecture Decision Record in Octadocs - the smart documentation environment.
- [GitHub](https://github.com/octadocs/octadocs-adr) (📦 2 · ⏱️ 22.08.2021)
- [PyPi](https://pypi.org/project/octadocs-adr) (📥 35 / month):
```
pip install octadocs-adr
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- octadocs_adr
```
## 📁 Snippets & includes (reusing contents)
include-markdown - 🥇25 · ⭐ 110 · Apache-2 ·
Mkdocs Markdown includer plugin.
- [GitHub](https://github.com/mondeja/mkdocs-include-markdown-plugin) (👨💻 16 · 🔀 20 · 📥 550 · 📦 2.6K · ⏱️ 17.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-include-markdown-plugin) (📥 310K / month):
```
pip install mkdocs-include-markdown-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- include-markdown
```
Markdown-Include - 🥈21 · ⭐ 100 · 💤 · ❗️GPL-3.0 ·
Provides syntax for Python-Markdown which allows for the inclusion of the contents of other Markdown documents.
- [GitHub](https://github.com/cmacmackin/markdown-include) (👨💻 12 · 🔀 36 · 📦 6.7K · 📋 26 - 26% open · ⏱️ 07.02.2023)
- [PyPi](https://pypi.org/project/markdown-include) (📥 110K / month):
```
pip install markdown-include
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- markdown_include.include
```
meta-descriptions - 🥈19 · ⭐ 18 · MIT ·
Generate meta descriptions from the first paragraphs in your MkDocs pages.
- [GitHub](https://github.com/prcr/mkdocs-meta-descriptions-plugin) (👨💻 3 · 🔀 3 · 📦 1.1K · 📋 11 - 9% open · ⏱️ 28.12.2024)
- [PyPi](https://pypi.org/project/mkdocs-meta-descriptions-plugin) (📥 7.8K / month):
```
pip install mkdocs-meta-descriptions-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- meta-descriptions
```
codeinclude - 🥈15 · ⭐ 14 · 💤 · MIT ·
A plugin to include code snippets into mkdocs pages.
- [GitHub](https://github.com/rnorth/mkdocs-codeinclude-plugin) (👨💻 4 · 🔀 7 · 📦 140 · 📋 12 - 41% open · ⏱️ 01.03.2023)
- [PyPi](https://pypi.org/project/mkdocs-codeinclude-plugin) (📥 4.9K / month):
```
pip install mkdocs-codeinclude-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- codeinclude
```
mkdocs-embed-external-markdown - 🥉14 · ⭐ 10 · MIT ·
MkDocs Embed External Markdown plugin that allow to inject section or all full markdown content from a given url. The..
- [GitHub](https://github.com/fire1ce/mkdocs-embed-external-markdown) (👨💻 7 · 🔀 8 · 📦 130 · 📋 12 - 8% open · ⏱️ 22.08.2024)
- [PyPi](https://pypi.org/project/mkdocs-embed-external-markdown) (📥 5.4K / month):
```
pip install mkdocs-embed-external-markdown
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- external-markdown
```
Mdx Include - 🥉11 · ⭐ 56 · 💤 · ❗Unlicensed ·
Python Markdown extension to include local or remote files.
- [GitHub](https://github.com/neurobin/mdx_include) (👨💻 3 · 🔀 3 · 📋 9 - 44% open · ⏱️ 26.07.2022)
- [PyPi](https://pypi.org/project/mdx-include) (📥 77K / month):
```
pip install mdx-include
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- mdx_include
```
snippet - 🥉11 · ⭐ 12 · 💤 · MIT ·
An mkdocs plugin that injects snippets from a file in a git repository.
- [GitHub](https://github.com/mprivat/mkdocs-snippet-plugin) (👨💻 3 · 🔀 3 · 📦 23 · 📋 7 - 42% open · ⏱️ 21.10.2021)
- [PyPi](https://pypi.org/project/mkdocs-snippet-plugin) (📥 1.1K / month):
```
pip install mkdocs-snippet-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- snippet
```
markdown-version-annotations - 🥉11 · ⭐ 6 · MIT ·
MkDocs plugin to add custom admonitions for documenting version differences.
- [GitHub](https://github.com/glennmatthews/markdown-version-annotations) (📥 26 · 📦 39 · ⏱️ 06.05.2024)
- [PyPi](https://pypi.org/project/markdown-version-annotations) (📥 5.2K / month):
```
pip install markdown-version-annotations
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions):
```yaml
markdown_extensions:
- markdown_version_annotations
```
git snippet - 🥉9 · ⭐ 6 · 💤 · MIT ·
Mkdocs plugin that allow to inject snippet or all markdown content from a given remote git repository.
- [GitHub](https://github.com/SamazoOo/mkdocs-gitsnippet-plugin) (👨💻 4 · 🔀 3 · 📦 10 · ⏱️ 15.11.2020)
- [PyPi](https://pypi.org/project/mkdocs-gitsnippet-plugin) (📥 830 / month):
```
pip install mkdocs-gitsnippet-plugin
```
- Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins):
```yaml
plugins:
- gitsnippet
```
---
## Related Resources
- [**Best-of lists**](https://best-of.org): Discover other best-of lists with awesome open-source projects on all kinds of topics.
## Contribution
Contributions are encouraged and always welcome! If you like to add or update projects, choose one of the following ways:
- Open an issue by selecting one of the provided categories from the [issue page](https://github.com/mkdocs/catalog/issues/new/choose) and fill in the requested information.
- Modify the [projects.yaml](https://github.com/mkdocs/catalog/blob/main/projects.yaml) with your additions or changes, and submit a pull request. This can also be done directly via the [Github UI](https://github.com/mkdocs/catalog/edit/main/projects.yaml).
If you like to contribute to or share suggestions regarding the project metadata collection or markdown generation, please refer to the [best-of-generator](https://github.com/best-of-lists/best-of-generator) repository. If you like to create your own best-of list, we recommend to follow [this guide](https://github.com/best-of-lists/best-of/blob/main/create-best-of-list.md).
For more information on how to add or update projects, please read the [contribution guidelines](https://github.com/mkdocs/catalog/blob/main/CONTRIBUTING.md). By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/mkdocs/catalog/blob/main/.github/CODE_OF_CONDUCT.md).
## License
[](https://creativecommons.org/licenses/by-sa/4.0/)