catalog

🏆 📚 A list of awesome MkDocs projects and plugins.

This list contains 260 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, submit a pull request, or directly edit the projects.yaml. Contributions are very welcome!

🧙‍♂️ Discover other best-of lists or create your own.

🎨 Theming 27 projects
💻 API documentation building 14 projects
💬 Blogging 7 projects
📊 Charts, Images, Tables & Graphs 34 projects
🤖 Code execution, variables & templating 19 projects
🌲 Git repos & info 10 projects
🌈 HTML processing & CSS styling 13 projects
📎 Integrations with other tools 8 projects
🌍 Internationalization & localization 3 projects
🔗 Links & references 21 projects
🧩 Markdown extensions 27 projects
🧭 Navigation & page building 26 projects
✅ Quality checks (code blocks, spelling, etc.) 5 projects
🔍 Search & tables of content 4 projects
🍱 Site conversion (PDF/ePUB/etc.) 11 projects
🔧 Site building, site management 20 projects
📁 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 · ⭐ 18K · MIT · ·
Documentation that simply works.

GitHub (👨‍💻 270 · 🔀 3.2K · 📦 47K · 📋 2.3K - 1% open · ⏱️ 29.04.2024)
PyPi (📥 4.4M / month):
```
 pip install mkdocs-material
```

Add to mkdocs.yml:

theme: material

Extras:

plugins:
  - blog
  - group
  - offline
  - search
  - social
  - tags

Cinder - 🥇20 · ⭐ 200 · 💤 · ❗Unlicensed ·
A clean, responsive MkDocs theme.

GitHub (👨‍💻 23 · 🔀 100 · 📥 970 · 📦 620 · 📋 51 - 31% open · ⏱️ 05.01.2021)
PyPi (📥 7.1K / month):
```
 pip install mkdocs-cinder
```
Add to mkdocs.yml:
```
theme: cinder
```

Bootswatch - 🥇20 · ⭐ 140 · BSD-2 ·
MkDocs Bootswatch Themes.

GitHub (👨‍💻 10 · 🔀 58 · 📦 1.1K · 📋 33 - 9% open · ⏱️ 29.12.2023)
PyPi (📥 15K / month):
```
 pip install mkdocs-bootswatch
```

Add to mkdocs.yml:

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

Dracula - 🥈18 · ⭐ 59 · MIT ·
Dark theme for Mkdocs.

GitHub (👨‍💻 4 · 🔀 7 · 📦 78 · ⏱️ 17.01.2024)
PyPi (📥 2.1K / month):
```
 pip install mkdocs-dracula-theme
```
Add to mkdocs.yml:
```
theme: dracula
```

Bootstrap - 🥈16 · ⭐ 77 · BSD-2 ·
MkDocs Bootstrap Theme.

GitHub (👨‍💻 6 · 🔀 37 · 📦 460 · 📋 16 - 6% open · ⏱️ 29.12.2023)
PyPi (📥 6.5K / month):
```
 pip install mkdocs-bootstrap
```
Add to mkdocs.yml:
```
theme: bootstrap
```

Simple Blog - 🥈16 · ⭐ 59 · MIT ·
Blog Template for Mkdocs.

GitHub (👨‍💻 3 · 🔀 4 · 📦 53 · 📋 19 - 47% open · ⏱️ 28.01.2024)
PyPi (📥 780 / month):
```
 pip install mkdocs-simple-blog
```
Add to mkdocs.yml:
```
theme: simple-blog
```

Terminal for MkDocs - 🥈15 · ⭐ 79 · 💤 · MIT ·
monospace theme for MkDocs.

GitHub (🔀 1 · 📦 66 · 📋 56 - 44% open · ⏱️ 15.04.2023)
PyPi (📥 1.1K / month):
```
 pip install mkdocs-terminal
```
Add to mkdocs.yml:
```
theme: terminal
```
Extras:
```
plugins:
  - md-to-html
```

Windmill - 🥈14 · ⭐ 98 · 💤 · ❗Unlicensed ·
Outstanding mkdocs theme with a focus on navigation and usability.

GitHub (👨‍💻 8 · 🔀 47 · 📦 300 · 📋 31 - 48% open · ⏱️ 11.03.2022)
PyPi (📥 3.1K / month):
```
 pip install mkdocs-windmill
```
Add to mkdocs.yml:
```
theme: windmill
```

Lantana - 🥈13 · ⭐ 11 · MIT ·
Lantana MKDocsHTML.

GitHub (👨‍💻 3 · 📥 190 · 📦 3 · 📋 19 - 5% open · ⏱️ 03.04.2024)
PyPi (📥 630 / month):
```
 pip install lantana
```
Add to mkdocs.yml:
```
theme: lantana
```

SWAN - 🥈12 · ⭐ 4 · ❗️AGPL-3.0 ·
SWAN MkDocs theme.

GitHub (👨‍💻 4 · 🔀 3 · 📦 3 · ⏱️ 23.01.2024)
PyPi (📥 160 / month):
```
 pip install mkdocs-swan
```
Add to mkdocs.yml:
```
theme: swan
```

Ivory - 🥈11 · ⭐ 10 · 💤 · MIT ·
Ivory theme for MkDocs.

GitHub (👨‍💻 2 · 🔀 4 · 📦 79 · 📋 5 - 40% open · ⏱️ 16.06.2020)
PyPi (📥 5.2K / month):
```
 pip install mkdocs-ivory
```
Add to mkdocs.yml:
```
theme: ivory
```

KPN for MkDocs - 🥈11 · ⭐ 7 · MIT ·
KPN theme for MkDocs | owner=flow.

GitHub (👨‍💻 3 · 📦 3 · ⏱️ 31.01.2024)
PyPi (📥 1.3K / month):
```
 pip install mkdocs-kpn
```
Add to mkdocs.yml:
```
theme: kpn
```

CustomMill - 🥉9 · ⭐ 12 · 💤 · ❗Unlicensed ·
Outstanding mkdocs theme with a focus on navigation, customization and usability.

GitHub (👨‍💻 8 · 🔀 5 · 📦 18 · ⏱️ 10.03.2022)
PyPi (📥 280 / month):
```
 pip install mkdocs-custommill
```
Add to mkdocs.yml:
```
theme: custommill
```

Zettelkasten - 🥉9 · ⭐ 8 · MIT ·
This is a Zettelkasten theme and plugin for MkDocs. It renders the MkDocs pages as cards (zettels).

GitHub (👨‍💻 3 · 📥 19 · 📦 3 · 📋 10 - 70% open · ⏱️ 19.02.2024)
PyPi (📥 110 / month):
```
 pip install mkdocs-zettelkasten
```

Add to mkdocs.yml:

theme: zettelkasten-solarized-light

Extras:

plugins:
  - zettelkasten

Bootstrap 4 - 🥉9 · ⭐ 5 · 💤 · MIT ·
A vanilla Bootstrap 4 theme for MkDocs.

GitHub (👨‍💻 3 · 📦 6 · 📋 5 - 20% open · ⏱️ 07.01.2023)
PyPi (📥 130 / month):
```
 pip install mkdocs-theme-bootstrap4
```

Add to mkdocs.yml:

theme: bootstrap4

Extras:

plugins:
  - bootstrap4-blockquotes
  - bootstrap4-tables

Alabaster - 🥉8 · ⭐ 36 · 💤 · ❗Unlicensed ·
Alabaster port for MkDocs.

GitHub (👨‍💻 9 · 🔀 9 · 📋 17 - 17% open · ⏱️ 16.06.2020)
PyPi (📥 710 / month):
```
 pip install mkdocs-alabaster
```
Add to mkdocs.yml:
```
theme: alabaster
```

Windmill Dark - 🥉8 · ⭐ 33 · 💤 · ❗Unlicensed ·
Outstanding mkdocs theme with a focus on navigation and usability.

GitHub (👨‍💻 4 · 🔀 10 · ⏱️ 12.05.2022)
PyPi (📥 490 / month):
```
 pip install mkdocs-windmill-dark
```
Add to mkdocs.yml:
```
theme: windmill-dark
```

GitBook - 🥉8 · ⭐ 27 · 💤 · ❗Unlicensed ·
Default theme for GitBook for Mkdocs https://lramage.gitlab.io/mkdocs-gitbook-theme.

PyPi (📥 8.8K / month):
```
 pip install mkdocs-gitbook
```
GitLab (🔀 12 · 📋 18 - 44% open · ⏱️ 17.12.2018)
Add to mkdocs.yml:
```
theme: gitbook
```

BOOTSTRAP386 - 🥉7 · ⭐ 31 · 💤 · ❗Unlicensed ·
A vintage 1980s DOS inspired Twitter Bootstrap theme for MkDocs https://lramage.gitlab.io/mkdocs-bootstrap386.

PyPi (📥 6.2K / month):
```
 pip install mkdocs-bootstrap386
```
GitLab (🔀 3 · 📋 7 - 57% open · ⏱️ 06.06.2018)
Add to mkdocs.yml:
```
theme: bootstrap386
```

docSkimmer - 🥉6 · ⭐ 18 · ❗Unlicensed ·
An accessible, skimmable theme for MkDocs.

GitHub (⏱️ 05.11.2023)
Add to mkdocs.yml:
```
theme: docskimmer
```

Nature - 🥉6 · ⭐ 5 · ❗Unlicensed ·
A MkDocs theme.

GitHub (👨‍💻 2 · 🔀 1 · 📦 41 · ⏱️ 14.09.2023)
PyPi (📥 870 / month):
```
 pip install mkdocs-nature
```
Add to mkdocs.yml:
```
theme: nature
```

Moonstone - 🥉6 · ⭐ 5 · 💤 · ❗Unlicensed ·
A documentation theme for mkdocs.

GitHub (🔀 1 · 📦 8 · ⏱️ 15.06.2021)
PyPi (📥 240 / month):
```
 pip install mkdocs-moonstone
```
Add to mkdocs.yml:
```
theme: moonstone
```

Risonia - 🥉6 · ⭐ 3 · ❗Unlicensed ·
A simple theme for MkDocs, using the w3.css framework and configurable color schemes.

GitHub (🔀 1 · 📦 2 · ⏱️ 01.09.2023)
PyPi (📥 140 / month):
```
 pip install mkdocs-risonia-theme
```

Add to mkdocs.yml:

theme: risonia

Extras:

plugins:
  - color-theme
  - w3css-classes

mkdocs-theme-topdf - 🥉5 · ⭐ 10 · 💤 · MPL-2.0 ·
A mkdocs theme for create PDF and printing with paged.js.

GitHub (🔀 1 · 📦 2 · ⏱️ 26.06.2021)
PyPi (📥 87 / month):
```
 pip install mkdocs-theme-topdf
```
Add to mkdocs.yml:
```
theme: topdf
```

GitHub - 🥉5 · ⭐ 2 · 💤 · MIT ·
Theme Mkdocs Like a Github. DEMO =.

GitHub (📦 8 · ⏱️ 25.02.2020)
PyPi (📥 56 / month):
```
 pip install mkdocs-github
```
Add to mkdocs.yml:
```
theme: github
```

mkdocs-rtl - 🥉4 · ⭐ 23 · 💤 · MIT
mkdocs rtl theme based on mkdocs-material.

GitHub (👨‍💻 2 · 🔀 4 · 📋 2 - 50% open · ⏱️ 22.10.2017)

Cluster - 🥉3 · ⭐ 4 · 💤 · ❗Unlicensed ·
Another bootstrap theme for MkDocs.

PyPi (📥 380 / month):
```
 pip install mkdocs-cluster
```
GitLab (🔀 1 · ⏱️ 02.06.2016)
Add to mkdocs.yml:
```
theme: cluster
```

💻 API documentation building

mkdocstrings - 🥇32 · ⭐ 1.6K · ISC ·
Automatic documentation from sources, for MkDocs.

GitHub (👨‍💻 42 · 🔀 100 · 📦 13K · 📋 390 - 11% open · ⏱️ 27.04.2024)
PyPi (📥 1.1M / month):
```
 pip install mkdocstrings
```
Add to mkdocs.yml:
```
plugins:
  - mkdocstrings
```

MkApi - 🥇21 · ⭐ 93 · MIT ·
A plugin for MkDocs to generate API documentation.

GitHub (👨‍💻 5 · 🔀 17 · 📦 180 · 📋 89 - 24% open · ⏱️ 03.04.2024)
PyPi (📥 6.5K / month):
```
 pip install mkapi
```
Add to mkdocs.yml:
```
plugins:
  - mkapi
```

mkdoxy - 🥈20 · ⭐ 52 · MIT ·
Automatically generates API documentation for your project based on Doxygen comments and code snippets in your..

GitHub (👨‍💻 11 · 🔀 15 · 📦 9 · 📋 51 - 15% open · ⏱️ 01.05.2024)
PyPi (📥 14K / month):
```
 pip install mkdoxy
```
Add to mkdocs.yml:
```
plugins:
  - mkdoxy
```

MkDocsOAD - 🥈18 · ⭐ 110 · 📉 · MIT · ·
Plugin for MkDocs to generate human readable documentation from OpenAPI Documentation Version 3 (also known as Swagger..

GitHub (👨‍💻 10 · 🔀 9 · 📥 1K · 📦 170 · 📋 35 - 40% open · ⏱️ 01.02.2024)
PyPi (📥 50K / month):
```
 pip install neoteroi-mkdocs
```

Add to mkdocs.yml:

plugins:
  - neoteroi.mkdocsoad
  - neoteroi.contribs
markdown_extensions:
  - neoteroi.cards
  - neoteroi.timeline
  - neoteroi.projects
  - neoteroi.spantable

mkdocs-click - 🥈18 · ⭐ 100 · Apache-2 ·
An MkDocs extension to generate documentation for Click command line applications.

GitHub (👨‍💻 13 · 🔀 15 · 📦 410 · 📋 29 - 48% open · ⏱️ 11.02.2024)
PyPi (📥 50K / month):
```
 pip install mkdocs-click
```
Add to mkdocs.yml:
```
markdown_extensions:
  - mkdocs-click
```

MkAutoDoc - 🥈16 · ⭐ 210 · 💤 · ❗️BSD ·
Auto documentation for MkDocs.

GitHub (👨‍💻 7 · 🔀 15 · 📦 790 · 📋 18 - 38% open · ⏱️ 26.09.2022)
PyPi (📥 10K / month):
```
 pip install mkautodoc
```
Add to mkdocs.yml:
```
markdown_extensions:
  - mkautodoc
```

mktheapidocs - 🥉12 · ⭐ 12 · 💤 · MIT ·
Numpydocs - mkdocs friendly markdown.

GitHub (👨‍💻 6 · 🔀 3 · 📦 39 · 📋 16 - 62% open · ⏱️ 10.06.2022)
PyPi (📥 550 / month):
```
 pip install mktheapidocs
```
Add to mkdocs.yml:
```
plugins:
  - mktheapidocs
```

mkdocs-typer - 🥉11 · ⭐ 27 · Apache-2 ·
An MkDocs extension to generate documentation for Typer command line applications.

GitHub (🔀 1 · 📋 6 - 50% open · ⏱️ 21.06.2023)
PyPi (📥 7.2K / month):
```
 pip install mkdocs-typer
```
Add to mkdocs.yml:
```
markdown_extensions:
  - mkdocs-typer
```

inari - 🥉8 · ⭐ 5 · 💤 · MIT ·
Write docstrings in markdown!.

GitHub (📦 6 · 📋 2 - 50% open · ⏱️ 10.07.2021)
PyPi (📥 160 / month):
```
 pip install inari
```
Add to mkdocs.yml:
```
plugins:
  - inari
```

automacdoc - 🥉7 · ⭐ 42 · 💤 · MIT
Automatic generation of documentation for mkdocs.

GitHub (👨‍💻 6 · 🔀 10 · 📋 5 - 80% open · ⏱️ 29.12.2020)
PyPi (📥 120 / month):
```
 pip install automacdoc
```

mkdocs-typedoc - 🥉7 · ⭐ 4 · MIT ·
The Mkdocs-Typedoc Plugin is designed to integrate TypeDoc documentation with your MkDocs project.

GitHub (👨‍💻 2 · 🔀 1 · ⏱️ 21.12.2023)
PyPi (📥 290 / month):
```
 pip install mkdocs-typedoc
```
Add to mkdocs.yml:
```
plugins:
  - typedoc
```

doxygen - 🥉6 · ⭐ 14 · 💤 · MIT ·
A Doxygen plugin for MkDocs.

GitHub (👨‍💻 3 · 🔀 4 · ⏱️ 04.12.2020)
Add to mkdocs.yml:
```
plugins:
  - doxygen
```

mkdocs-yaarg-plugin - 🥉2 · ⭐ 2 · 💤 · ❗Unlicensed ·
Yet Another API Reference Generator plugin for MKDocs.

GitHub (⏱️ 14.03.2021)
PyPi (📥 48 / month):
```
 pip install mkdocs-yaarg-plugin
```
Add to mkdocs.yml:
```
plugins:
  - yaarg
```

ansible-document - 🥉2 · ❗Unlicensed
Auto-generate ansible role documentation.

PyPi (📥 36 / month):
```
 pip install ansible-mkdocs
```

💬 Blogging

rss - 🥇24 · ⭐ 62 · MIT ·
MkDocs plugin to generate a RSS feeds for created and updated pages, using git log and YAML frontmatter (page.meta).

GitHub (👨‍💻 13 · 🔀 20 · 📥 55 · 📦 490 · 📋 43 - 37% open · ⏱️ 01.05.2024)
PyPi (📥 35K / month):
```
 pip install mkdocs-rss-plugin
```
Add to mkdocs.yml:
```
plugins:
  - rss
```

mkdocs-blogging-plugin - 🥈17 · ⭐ 82 · MIT ·
Add blogging feature to your MkDocs site.

GitHub (👨‍💻 7 · 🔀 16 · 📥 11 · 📦 170 · 📋 40 - 10% open · ⏱️ 21.07.2023)
PyPi (📥 3.7K / month):
```
 pip install mkdocs-blogging-plugin
```
Add to mkdocs.yml:
```
plugins:
  - blogging
```

Publisher for MkDocs - blog - 🥈15 · ⭐ 28 · MIT ·
Blogging engine.

GitHub (👨‍💻 2 · 🔀 1 · 📥 9 · 📦 31 · 📋 13 - 30% open · ⏱️ 21.04.2024)
PyPi (📥 2K / month):
```
 pip install mkdocs-publisher
```
Add to mkdocs.yml:
```
plugins:
  - pub-blog
```

newsletter - 🥉12 · ⭐ 26 · ❗️GPL-3.0 ·
Automatically create newsletters from the changes in a mkdocs repository.

GitHub (👨‍💻 3 · 🔀 2 · 📦 39 · 📋 10 - 30% open · ⏱️ 25.03.2024)
PyPi (📥 760 / month):
```
 pip install mkdocs-newsletter
```
Add to mkdocs.yml:
```
plugins:
  - mkdocs-newsletter
```

Blogs for MkDocs - 🥉12 · ⭐ 16 · 💤 · MIT ·
This plugin for MkDocs allows to keeps a really simple blog section inside your documentation site.

GitHub (🔀 4 · 📦 98 · 📋 2 - 50% open · ⏱️ 13.04.2020)
PyPi (📥 4.9K / month):
```
 pip install mkdocs-blog-plugin
```
Add to mkdocs.yml:
```
plugins:
  - blog
```

blog - 🥉3 · ⭐ 14 · 💤 · ❗Unlicensed ·
Blogging in mkdocs.

GitHub (🔀 7 · 📋 5 - 80% open · ⏱️ 02.11.2020)
Add to mkdocs.yml:
```
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 (👨‍💻 2 · 🔀 1 · ⏱️ 14.04.2021)
PyPi (📥 71 / month):
```
 pip install mkblog
```
Add to mkdocs.yml:
```
plugins:
  - mkblog
```

📊 Charts, Images, Tables & Graphs

plantuml-markdown - 🥇28 · ⭐ 190 · BSD-2 ·
PlantUML plugin for Python-Markdown.

GitHub (👨‍💻 28 · 🔀 53 · 📦 1.3K · 📋 64 - 1% open · ⏱️ 24.04.2024)
PyPi (📥 310K / month):
```
 pip install plantuml-markdown
```

Add to mkdocs.yml:

markdown_extensions:
  - plantuml_markdown

mermaid2 - 🥇23 · ⭐ 190 · MIT ·
A Mermaid graphs plugin for mkdocs.

GitHub (👨‍💻 13 · 🔀 25 · 📦 1.9K · 📋 66 - 10% open · ⏱️ 06.03.2024)
PyPi (📥 160K / month):
```
 pip install mkdocs-mermaid2-plugin
```
Add to mkdocs.yml:
```
plugins:
  - mermaid2
```

MkDocs GLightbox - 🥇22 · ⭐ 100 · 📈 · MIT ·
A MkDocs plugin supports image lightbox (zoom effect) with GLightbox.

GitHub (👨‍💻 4 · 🔀 14 · 📥 24 · 📦 2.5K · 📋 34 - 32% open · ⏱️ 02.05.2024)
PyPi (📥 210K / month):
```
 pip install mkdocs-glightbox
```
Add to mkdocs.yml:
```
plugins:
  - glightbox
```

table-reader - 🥇21 · ⭐ 100 · 📉 · MIT ·
MkDocs plugin that enables a markdown tag like {{ read_csv(table.csv) }} to directly insert various table formats into..

GitHub (👨‍💻 8 · 🔀 17 · 📦 640 · 📋 41 - 9% open · ⏱️ 15.04.2024)

PyPi (📥 39K / month):

 pip install mkdocs-table-reader-plugin

Add to mkdocs.yml:
```
plugins:
  - table-reader
```

drawio-exporter - 🥇21 · ⭐ 71 · MIT ·
Exports your Draw.io diagrams at build time for easier embedding into your documentation.

GitHub (👨‍💻 5 · 🔀 5 · 📦 67 · 📋 27 - 14% open · ⏱️ 23.04.2024)
PyPi (📥 12K / month):
```
 pip install mkdocs-drawio-exporter
```
Add to mkdocs.yml:
```
plugins:
  - drawio-exporter
```

build-plantuml - 🥈18 · ⭐ 54 · MIT ·
MkDocs plugin to help generate your plantuml images locally or remotely as files (NOT inline).

GitHub (👨‍💻 11 · 🔀 14 · 📦 100 · 📋 22 - 4% open · ⏱️ 25.03.2024)

PyPi (📥 35K / month):

 pip install mkdocs-build-plantuml-plugin

Add to mkdocs.yml:
```
plugins:
  - build_plantuml
```

kroki - 🥈18 · ⭐ 38 · MIT ·
MkDocs plugin for Kroki-Diagrams.

GitHub (👨‍💻 13 · 🔀 24 · 📦 35 · 📋 23 - 30% open · ⏱️ 21.01.2024)
PyPi (📥 26K / month):
```
 pip install mkdocs-kroki-plugin
```
Add to mkdocs.yml:
```
plugins:
  - kroki
```

charts - 🥈17 · ⭐ 70 · MIT ·
Mkdocs plugin to add vegalite charts to your pages.

GitHub (👨‍💻 3 · 🔀 6 · 📦 60 · 📋 19 - 15% open · ⏱️ 25.09.2023)
PyPi (📥 6.1K / month):
```
 pip install mkdocs-charts-plugin
```
Add to mkdocs.yml:
```
plugins:
  - charts
```

MkDocs Video - 🥈17 · ⭐ 65 · MIT ·
MkDocs Video plugin.

GitHub (👨‍💻 5 · 🔀 12 · 📥 42 · 📦 640 · ⏱️ 04.01.2024)
PyPi (📥 60K / month):
```
 pip install mkdocs-video
```
Add to mkdocs.yml:
```
plugins:
  - mkdocs-video
```

Markdown blockdiag - 🥈17 · ⭐ 26 · MIT ·
blockdiag extension for Python Markdown.

GitHub (👨‍💻 5 · 🔀 9 · 📦 100 · 📋 6 - 50% open · ⏱️ 22.11.2023)
PyPi (📥 3.1K / month):
```
 pip install markdown-blockdiag
```

Add to mkdocs.yml:

markdown_extensions:
  - markdown_blockdiag

Lightgallery - 🥈14 · ⭐ 26 · MIT ·
Markdown extension to wrap images in a lightbox.

GitHub (👨‍💻 6 · 🔀 4 · 📦 92 · 📋 11 - 54% open · ⏱️ 07.10.2023)
PyPi (📥 4K / month):
```
 pip install lightgallery
```
Add to mkdocs.yml:
```
markdown_extensions:
  - lightgallery
```

mkdocs-diagrams - 🥈13 · ⭐ 25 · 💤 · MIT ·
MkDocs plugin to render Diagrams files.

GitHub (🔀 3 · 📦 59 · 📋 3 - 33% open · ⏱️ 04.09.2020)
PyPi (📥 20K / month):
```
 pip install mkdocs-diagrams
```
Add to mkdocs.yml:
```
plugins:
  - diagrams
```

markdownmermaid - 🥈12 · ⭐ 26 · 💤 · MIT ·
A MkDocs plugin that support mermaid graph in markdown file.

GitHub (👨‍💻 2 · 🔀 15 · 📦 82 · 📋 6 - 33% open · ⏱️ 26.05.2019)
PyPi (📥 6.9K / month):
```
 pip install mkdocs-mermaid-plugin
```
Add to mkdocs.yml:
```
plugins:
  - markdownmermaid
```

mkdocs-d2-plugin - 🥈11 · ⭐ 10 · MIT ·
A plugin for embedding D2 diagrams in MkDocs.

GitHub (👨‍💻 3 · 🔀 3 · 📦 3 · ⏱️ 24.04.2024)
PyPi (📥 5.3K / month):
```
 pip install mkdocs-d2-plugin
```
Add to mkdocs.yml:
```
plugins:
  - d2
```

MkDocs Img2Fig Plugin - 🥉10 · ⭐ 18 · 💤 · MIT ·
A MkDocs plugin that converts markdown encoded images into figure elements.

GitHub (👨‍💻 2 · 🔀 7 · 📦 110 · 📋 3 - 66% open · ⏱️ 14.07.2020)
PyPi (📥 2.4K / month):
```
 pip install mkdocs-img2fig-plugin
```
Add to mkdocs.yml:
```
plugins:
  - img2fig
```

markdown-captions - 🥉10 · ⭐ 9 · ❗️GPL-3.0 ·
Python-Markdown plugin for image captions.

GitHub (👨‍💻 2 · 🔀 4 · 📦 140 · 📋 7 - 14% open · ⏱️ 24.05.2023)
PyPi (📥 2.4K / month):
```
 pip install markdown-captions
```

Add to mkdocs.yml:

markdown_extensions:
  - markdown_captions

Termage - 🥉9 · ⭐ 20 · 💤 · MIT ·
Generate SVGs from any Python code, even in your documentation.

GitHub (📦 1 · 📋 5 - 20% open · ⏱️ 23.08.2022)
PyPi (📥 180 / month):
```
 pip install Termage
```
Add to mkdocs.yml:
```
plugins:
  - termage
```

docutools - 🥉9 · ⭐ 19 · BSD-2 ·
Dev Centric Tools for Mkdocs Based Documentation.

GitHub (👨‍💻 3 · 📦 6 · 📋 2 - 50% open · ⏱️ 04.09.2023)
PyPi (📥 420 / month):
```
 pip install docutools
```

Add to mkdocs.yml:

plugins:
  - lcd-find-pages
  - lcd-custom-dir
  - lcd-blacklist
  - lcd-lp
  - lcd-md-replace
  - lcd-page-tree
  - lcd-stats

markdownwavedrom - 🥉8 · ⭐ 9 · 💤 · MPL-2.0 ·
A MkDocs plugin for support wavedrom charts in markdown file.

GitHub (🔀 2 · 📦 10 · 📋 3 - 33% open · ⏱️ 26.06.2021)
PyPi (📥 170 / month):
```
 pip install mkdocs-wavedrom-plugin
```
Add to mkdocs.yml:
```
plugins:
  - markdownwavedrom
```

badges - 🥉8 · ⭐ 9 · MIT ·
Add badges to your mkdocs page.

GitHub (🔀 1 · ⏱️ 08.02.2024)
PyPi (📥 1.4K / month):
```
 pip install mkdocs-badges
```
Add to mkdocs.yml:
```
plugins:
  - badges
```

Interactive Graph - 🥉8 · ⭐ 3 · 🐣 · MIT ·
interactive graph for Material for MkDocs like Obsidian, refer demo:.

GitHub (👨‍💻 2 · 📦 1 · ⏱️ 24.04.2024)

PyPi (📥 130 / month):

 pip install mkdocs-obsidian-interactive-graph-plugin

Add to mkdocs.yml:
```
plugins:
  - obsidian-interactive-graph
```

Markdown aafigure - 🥉7 · ⭐ 4 · 💤 · MIT ·
aafigure extension for Python Markdown.

GitHub (🔀 1 · 📋 3 - 33% open · ⏱️ 30.04.2021)
PyPi (📥 200 / month):
```
 pip install markdown-aafigure
```

Add to mkdocs.yml:

markdown_extensions:
  - markdown_aafigure

MkDocs Graphviz - 🥉6 · ⭐ 5 · 💤 · ❗Unlicensed ·
A mkdocs Extension that automatically renders Graphviz images, in SVG or PNG format, within your markdown file.

PyPi (📥 4.9K / month):
```
 pip install mkdocs-graphviz
```
GitLab (🔀 1 · 📋 7 - 42% open · ⏱️ 03.05.2021)

Add to mkdocs.yml:

markdown_extensions:
  - mkdocs_graphviz

mkdocs-resize-images - 🥉6 · ⭐ 1 · MIT ·
MkDocs plugin to resize images according to the configuration.

GitHub (📦 4 · ⏱️ 04.11.2023)
PyPi (📥 86 / month):
```
 pip install mkdocs-resize-images
```
Add to mkdocs.yml:
```
plugins:
  - resize-images
```

plotly charts - 🥉5 · ⭐ 7 · MIT ·
Mkdocs plugin to add interactive charts with Plotly.js.

GitHub (👨‍💻 2 · ⏱️ 25.07.2023)
PyPi (📥 1K / month):
```
 pip install mkdocs-plotly-plugin
```
Add to mkdocs.yml:
```
plugins:
  - plotly
```

thumbnails - 🥉5 · ⭐ 2 · MIT ·
MkDocs plugin for thumbnail images generated automatically.

GitHub (📋 2 - 50% open · ⏱️ 05.06.2023)
PyPi (📥 260 / month):
```
 pip install mkdocs-thumbnails
```
Add to mkdocs.yml:
```
plugins:
  - thumbnails
```

markdown-figcap - 🥉5 · ⭐ 1 · 💤 · BSD-3 ·
Extension for Python-Markdown to handle figure and figcaption.

GitHub (📦 3 · ⏱️ 09.03.2019)
PyPi (📥 74 / month):
```
 pip install markdown-figcap
```

Add to mkdocs.yml:

markdown_extensions:
  - markdown_figcap

pico-8 - 🥉5 · ⭐ 1 · 💤 · MIT ·
A MKDocs plugin that allows to embed a Pico-8 web player in a page.

GitHub (📦 1 · ⏱️ 17.03.2019)
PyPi (📥 24 / month):
```
 pip install pico8-mkdocs-plugin
```
Add to mkdocs.yml:
```
plugins:
  - pico-8
```

Family tree example - 🥉4 · ⭐ 2 · ❗️GPL-3.0
An interactive family tree visualization using d3-dag.

GitHub (👨‍💻 6 · 🔀 1 · ⏱️ 04.08.2023)

sequence-js - 🥉3 · ⭐ 4 · 💤 · MIT ·
MkDocs plugin to render sequence.js blocks.

GitHub (🔀 2 · 📋 3 - 33% open · ⏱️ 28.02.2020)
Add to mkdocs.yml:
```
plugins:
  - sequence-js
```

import-statement - 🥉3 · ⭐ 2 · 💤 · MIT ·

GitHub (📦 1 · ⏱️ 06.02.2023)

PyPi (📥 67 / month):

 pip install mkdocs-import-statement-plugin

Add to mkdocs.yml:
```
plugins:
  - import-statement
```

inline-svg - 🥉3 · MIT ·

GitHub (👨‍💻 5 · 🔀 1 · 📦 1 · ⏱️ 12.01.2024)

PyPi (📥 140 / month):

 pip install mkdocs-plugin-inline-svg-mod

Add to mkdocs.yml:
```
plugins:
  - inline-svg
```

MkHack3rs - 🥉2 · ⭐ 4 · 💤 · ❗Unlicensed ·
Hacks & Integrations for Mkdocs / Material Theme.

GitLab (🔀 1 · ⏱️ 01.05.2021)

image-formatter-plugin - 🥉2 · ⭐ 3 · 🐣 · ❗Unlicensed ·

GitHub (👨‍💻 7 · ⏱️ 06.12.2023)

PyPi (📥 24 / month):

 pip install mkdocs-image-formatter-plugin

Add to mkdocs.yml:
```
plugins:
  - image-formatter
```

🤖 Code execution, variables & templating

macros - 🥇27 · ⭐ 290 · MIT ·
Create richer and more beautiful pages in MkDocs, by using variables and calls to macros in the markdown code.

GitHub (👨‍💻 30 · 🔀 45 · 📦 3.1K · 📋 120 - 5% open · ⏱️ 28.04.2024)
PyPi (📥 350K / month):
```
 pip install mkdocs-macros-plugin
```
Add to mkdocs.yml:
```
plugins:
  - macros
```

mkdocs-jupyter - 🥇24 · ⭐ 330 · Apache-2 ·
Use Jupyter Notebook in mkdocs.

GitHub (👨‍💻 24 · 🔀 42 · 📦 2.3K · 📋 120 - 20% open · ⏱️ 09.04.2024)
PyPi (📥 120K / month):
```
 pip install mkdocs-jupyter
```
Add to mkdocs.yml:
```
plugins:
  - mkdocs-jupyter
```

markdownextradata - 🥈21 · ⭐ 77 · 💤 · MIT ·
A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template.

GitHub (👨‍💻 10 · 🔀 17 · 📦 1.1K · 📋 34 - 23% open · ⏱️ 15.12.2021)

PyPi (📥 39K / month):

 pip install mkdocs-markdownextradata-plugin

Add to mkdocs.yml:
```
plugins:
  - markdownextradata
```

mknotebooks - 🥈20 · ⭐ 130 · MIT ·
A plugin for mkdocs to help you include Jupyter notebooks in your projects.

GitHub (👨‍💻 14 · 🔀 20 · 📦 530 · 📋 39 - 33% open · ⏱️ 11.08.2023)
PyPi (📥 15K / month):
```
 pip install mknotebooks
```
Add to mkdocs.yml:
```
plugins:
  - mknotebooks
```

gen-files - 🥈20 · ⭐ 86 · MIT ·
MkDocs plugin to programmatically generate documentation pages during the build.

GitHub (👨‍💻 5 · 🔀 7 · 📦 2.1K · 📋 23 - 21% open · ⏱️ 27.04.2024)
PyPi (📥 260K / month):
```
 pip install mkdocs-gen-files
```
Add to mkdocs.yml:
```
plugins:
  - gen-files
```

markdown-exec - 🥈20 · ⭐ 72 · ISC ·
Utilities to execute code blocks in Markdown files.

GitHub (👨‍💻 2 · 🔀 5 · 📦 230 · 📋 36 - 41% open · ⏱️ 15.04.2024)
PyPi (📥 23K / month):
```
 pip install markdown-exec
```
Add to mkdocs.yml:
```
plugins:
  - markdown-exec
```

mkdocs-markmap - 🥈15 · ⭐ 38 · MIT ·
MkDocs plugin and extension to create mindmaps from markdown using markmap.

GitHub (👨‍💻 3 · 🔀 5 · 📥 170 · 📋 26 - 11% open · ⏱️ 05.10.2023)
PyPi (📥 2.3K / month):
```
 pip install mkdocs-markmap
```
Add to mkdocs.yml:
```
plugins:
  - markmap
```

Termynal - 🥈13 · ⭐ 79 · MIT ·
Python markdown terminal. Built for mkdocs.

GitHub (👨‍💻 5 · 🔀 7 · 📦 160 · 📋 15 - 46% open · ⏱️ 18.02.2024)
PyPi (📥 7.2K / month):
```
 pip install termynal
```
Add to mkdocs.yml:
```
plugins:
  - termynal
```

pheasant - 🥈13 · ⭐ 16 · 💤 · MIT ·
Documentation tool for Markdown conversion by Jupyter client.

GitHub (👨‍💻 4 · 🔀 9 · 📦 43 · ⏱️ 19.12.2020)
PyPi (📥 640 / month):
```
 pip install pheasant
```
Add to mkdocs.yml:
```
plugins:
  - pheasant
```

user-defined-values - 🥉12 · ⭐ 4 · 💤 · MIT ·
MkDocs User Defined Values.

GitHub (👨‍💻 3 · 🔀 3 · 📥 10 · 📦 12 · ⏱️ 10.07.2022)

PyPi (📥 800 / month):

 pip install mkdocs-user-defined-values

Add to mkdocs.yml:
```
plugins:
  - user-defined-values
```

placeholder - 🥉10 · ⭐ 7 · MIT ·
Add placeholders to your MkDocs pages.

GitHub (👨‍💻 2 · 🔀 3 · 📋 5 - 20% open · ⏱️ 28.04.2024)
PyPi (📥 800 / month):
```
 pip install mkdocs-placeholder-plugin
```
Add to mkdocs.yml:
```
plugins:
  - placeholder
```

nbconvert - 🥉9 · ⭐ 6 · BSD-2 ·
A MkDocs plug-in provides a source parser for *.ipynb files.

GitHub (👨‍💻 5 · 🔀 1 · 📦 2 · ⏱️ 09.04.2024)
PyPi (📥 640 / month):
```
 pip install mkdocs-nbconvert
```
Add to mkdocs.yml:
```
plugins:
  - nbconvert
```

markdown-filter - 🥉8 · ⭐ 3 · 💤 · MIT ·
Adds a markdown template filter to the jinja templating environment in mkdocs.

GitHub (🔀 1 · 📦 20 · ⏱️ 06.02.2019)
PyPi (📥 530 / month):
```
 pip install mkdocs-markdown-filter
```
Add to mkdocs.yml:
```
plugins:
  - markdown-filter
```

meta-manager - 🥉8 · ⭐ 1 · 💤 · MIT ·
MkDocs plugin for managing meta tags across folders and files.

GitHub (👨‍💻 3 · 🔀 1 · 📦 5 · 📋 3 - 66% open · ⏱️ 24.03.2023)
PyPi (📥 1.7K / month):
```
 pip install mkdocs-meta-manager
```
Add to mkdocs.yml:
```
plugins:
  - meta-manager
```

mkjsfiddle - 🥉7 · ⭐ 4 · MIT ·
An MkDocs plugin that lets you edit code fences in JSFiddle.

GitHub (⏱️ 07.06.2023)
PyPi (📥 120 / month):
```
 pip install mkjsfiddle
```
Add to mkdocs.yml:
```
plugins:
  - jsfiddle
```

Entangled - 🥉7 · Apache-2 ·
An MkDocs plugin that lets you do Literate Programming through Entangled.

GitHub (📦 6 · ⏱️ 14.10.2023)
PyPi (📥 100 / month):
```
 pip install mkdocs-entangled-plugin
```
Add to mkdocs.yml:
```
plugins:
  - entangled
```

jinja2sandbox - 🥉5 · ⭐ 3 · 💤 · MIT ·
A MkDocs plugin that enables the Jinja2-sandbox.

GitHub (⏱️ 20.03.2019)
Add to mkdocs.yml:
```
plugins:
  - jinja2sandbox
```

codeyaml - 🥉5 · 💤 · MIT ·
Allows for more than one yaml config in mkdocs.

GitHub (🔀 1 · ⏱️ 30.04.2019)
PyPi (📥 41 / month):
```
 pip install mkdocs-codeyaml-plugin
```
Add to mkdocs.yml:
```
plugins:
  - codeyaml
```

mkdocs_protobuf - 🥉4 · ⭐ 2 · 💤 · Apache-2 ·
Mkdocs plugin to render protobuf messages.

GitHub (👨‍💻 2 · 🔀 1 · ⏱️ 30.03.2022)
PyPi (📥 290 / month):
```
 pip install mkdocs-protobuf
```
Add to mkdocs.yml:
```
plugins:
  - mkdocs_protobuf
```

🌲 Git repos & info

git-revision-date-localized - 🥇29 · ⭐ 170 · MIT ·
MkDocs plugin to add a last updated date to your site pages.

GitHub (👨‍💻 24 · 🔀 33 · 📦 6.5K · 📋 84 - 13% open · ⏱️ 30.04.2024)

PyPi (📥 470K / month):

 pip install mkdocs-git-revision-date-localized-plugin

Add to mkdocs.yml:

plugins:
  - git-revision-date-localized

git-authors - 🥈23 · ⭐ 67 · MIT ·
MkDocs plugin to display git authors of a page.

GitHub (👨‍💻 10 · 🔀 16 · 📦 760 · 📋 55 - 18% open · ⏱️ 12.03.2024)
PyPi (📥 75K / month):
```
 pip install mkdocs-git-authors-plugin
```
Add to mkdocs.yml:
```
plugins:
  - git-authors
```

git-committers-2 - 🥈22 · ⭐ 42 · MIT ·
An MkDocs plugin to create a list of contributors on the page.

GitHub (👨‍💻 12 · 🔀 15 · 📦 530 · 📋 33 - 21% open · ⏱️ 05.04.2024)

PyPi (📥 26K / month):

 pip install mkdocs-git-committers-plugin-2

Add to mkdocs.yml:
```
plugins:
  - git-committers
```

git-revision-date - 🥈20 · ⭐ 56 · 💤 · MIT ·
MkDocs plugin for setting revision date from git per markdown file.

GitHub (👨‍💻 7 · 🔀 8 · 📦 2.1K · 📋 14 - 35% open · ⏱️ 08.03.2022)

PyPi (📥 71K / month):

 pip install mkdocs-git-revision-date-plugin

Add to mkdocs.yml:
```
plugins:
  - git-revision-date
```

git-committers - 🥉15 · ⭐ 35 · MIT ·
A mkdocs plugin for displaying the last commit and a list of a files contributors.

GitHub (👨‍💻 6 · 🔀 8 · 📦 180 · ⏱️ 06.11.2023)

PyPi (📥 9.9K / month):

 pip install mkdocs-git-committers-plugin

Add to mkdocs.yml:
```
plugins:
  - git-committers
```

Github-Links - 🥉9 · ⭐ 10 · ❗Unlicensed ·
Python-Markdown GitHub Links Extension.

GitHub (👨‍💻 4 · 🔀 10 · ⏱️ 22.12.2023)
PyPi (📥 8.8K / month):
```
 pip install mdx-gh-links
```
Add to mkdocs.yml:
```
markdown_extensions:
  - mdx_gh_links
```

mkdocs-git-latest-changes-plugin - 🥉9 · ⭐ 1 · 🐣 · MIT ·
MkDocs plugin that allows you to display a list of recently modified pages from the Git log.

GitHub (👨‍💻 2 · 🔀 1 · 📦 2 · 📋 9 - 22% open · ⏱️ 07.03.2024)

PyPi (📥 310 / month):

 pip install mkdocs-git-latest-changes-plugin

Add to mkdocs.yml:
```
plugins:
  - git-latest-changes
```

branchcustomization - 🥉8 · ⭐ 2 · 💤 · MIT ·
Customize MkDocs options on a per-branch basis.

GitHub (📦 15 · ⏱️ 17.04.2022)

PyPi (📥 2.1K / month):

 pip install mkdocs-branchcustomization-plugin

Add to mkdocs.yml:
```
plugins:
  - branchcustomization
```

git-latest-release - 🥉5 · 💤 · ❗️GPL-3.0 ·
Plugin for MKDocs to inject the latest release tag from git into markdown.

GitHub (👨‍💻 3 · ⏱️ 29.12.2019)

PyPi (📥 740 / month):

 pip install mkdocs-latest-release-plugin

Add to mkdocs.yml:
```
plugins:
  - git-latest-release
```

Github Releaase Changelog - 🥉4 · ⭐ 1 · 🐣 · MIT ·
mkdocs extension to autogenerate changelog from github releases.

GitHub (👨‍💻 2 · ⏱️ 02.01.2024)
PyPi (📥 24 / month):
```
 pip install mkdocs-github-changelog
```
Add to mkdocs.yml:
```
plugins:
  - mkdocs_github_changelog
```

🌈 HTML processing & CSS styling

minify - 🥇21 · ⭐ 130 · 📉 · MIT ·
A mkdocs plugin to minify the HTML of a page before it is written to disk.

GitHub (👨‍💻 14 · 🔀 17 · 📦 7.5K · 📋 17 - 23% open · ⏱️ 29.01.2024)
PyPi (📥 200K / month):
```
 pip install mkdocs-minify-plugin
```
Add to mkdocs.yml:
```
plugins:
  - minify
```

enumerate-headings - 🥇21 · ⭐ 37 · MIT ·
MkDocs Plugin to enumerate the headings across site pages.

GitHub (👨‍💻 5 · 🔀 7 · 📦 190 · 📋 30 - 6% open · ⏱️ 16.04.2024)

PyPi (📥 15K / month):

 pip install mkdocs-enumerate-headings-plugin

Add to mkdocs.yml:
```
plugins:
  - enumerate-headings
```

minify-html - 🥈17 · ⭐ 3 · MIT ·
MkDocs plugin for minification using minify-html, an extremely fast and smart HTML + JS + CSS minifier.

GitHub (👨‍💻 3 · 📦 13 · ⏱️ 02.05.2024)
PyPi (📥 2.5K / month):
```
 pip install mkdocs-minify-html-plugin
```
Add to mkdocs.yml:
```
plugins:
  - minify_html
```

Publisher for MkDocs - social - 🥈15 · ⭐ 28 · MIT ·
Social media sharing helper.

GitHub (👨‍💻 2 · 🔀 1 · 📥 9 · 📦 31 · 📋 13 - 30% open · ⏱️ 21.04.2024)
PyPi (📥 2K / month):
```
 pip install mkdocs-publisher
```
Add to mkdocs.yml:
```
plugins:
  - pub-social
```

Publisher for MkDocs - minifier - 🥈15 · ⭐ 28 · MIT ·
HTML, CSS and graphics files size optimization.

GitHub (👨‍💻 2 · 🔀 1 · 📥 9 · 📦 31 · 📋 13 - 30% open · ⏱️ 21.04.2024)
PyPi (📥 2K / month):
```
 pip install mkdocs-publisher
```
Add to mkdocs.yml:
```
plugins:
  - pub-minifier
```

mkdocs-link-embeds - 🥉12 · ⭐ 2 · 🐣 · MIT ·
Mkdocs plugin which displays links in a more elegant way. Links will automatically be populated with an image,..

GitHub (📥 1 · ⏱️ 13.04.2024)
PyPi (📥 320 / month):
```
 pip install mkdocs-link-embeds-plugin
```
Add to mkdocs.yml:
```
plugins:
  - link-embeds
```

add-number - 🥉11 · ⭐ 15 · 💤 · MIT ·
MkDocs plugin to automatically number the headings (h1-h6) in each markdown page and the nav.

GitHub (👨‍💻 3 · 🔀 3 · 📦 33 · 📋 11 - 18% open · ⏱️ 11.06.2020)
PyPi (📥 5.4K / month):
```
 pip install mkdocs-add-number-plugin
```
Add to mkdocs.yml:
```
plugins:
  - add-number
```

bootstrap-tables - 🥉9 · ⭐ 11 · 💤 · MIT ·
A MkDocs plugin to add bootstrap classes to plan markdown generated tables.

GitHub (🔀 2 · 📦 70 · ⏱️ 27.03.2020)

PyPi (📥 1.2K / month):

 pip install mkdocs-bootstrap-tables-plugin

Add to mkdocs.yml:
```
plugins:
  - bootstrap-tables
```

mkdocs_safe_text - 🥉9 · ⭐ 3 · BSD-2 ·
Plugin for safe text editing with MKDocs.

GitHub (👨‍💻 2 · ⏱️ 20.10.2023)
PyPi (📥 780 / month):
```
 pip install mkdocs-safe-text-plugin
```
Add to mkdocs.yml:
```
plugins:
  - mkdocs_safe_text
```

mkdocs-extra-sass-plugin - 🥉9 · ⭐ 2 · 💤 · MIT ·
Adds stylesheets to your mkdocs site from Sass/SCSS.

GitHub (🔀 2 · 📦 23 · ⏱️ 13.02.2021)
PyPi (📥 5.6K / month):
```
 pip install mkdocs-extra-sass-plugin
```
Add to mkdocs.yml:
```
plugins:
  - extra-sass
```

mkdocs-add-teaser - 🥉8 · ⭐ 4 · 💤 · MIT ·
An MkDocs plugin to customize the first paragraph of your pages, and to use it as the pages meta description.

GitHub (👨‍💻 3 · 🔀 1 · 📦 1 · ⏱️ 08.11.2022)
PyPi (📥 340 / month):
```
 pip install mkdocs-add-teaser
```
Add to mkdocs.yml:
```
plugins:
  - mkdocs-add-teaser
```

toggle-sidebar - 🥉5 · ⭐ 2 · MIT ·
Toggle the navigation and/or TOC sidebars on your MkDocs site.

GitHub (⏱️ 23.09.2023)

PyPi (📥 260 / month):

 pip install mkdocs-toggle-sidebar-plugin

Add to mkdocs.yml:
```
plugins:
  - toggle-sidebar
```

docstyler - 🥉4 · 💤 · BSD-3 ·
Plugin to add alternative stylesheets to MkDocs custom themes.

GitHub (⏱️ 16.02.2019)
Add to mkdocs.yml:
```
plugins:
  - docstyler
```

📎 Integrations with other tools

MkDocs Swagger UI Tag - 🥇19 · ⭐ 67 · MIT ·
A MkDocs plugin supports adding Swagger UI to the page.

GitHub (👨‍💻 3 · 🔀 6 · 📥 27 · 📦 130 · 📋 21 - 19% open · ⏱️ 01.05.2024)
PyPi (📥 32K / month):
```
 pip install mkdocs-swagger-ui-tag
```
Add to mkdocs.yml:
```
plugins:
  - swagger-ui-tag
```

mkdocs-render-swagger-plugin - 🥈15 · ⭐ 62 · MIT ·
A plugin for MKDocs for rendering swagger & openapi schemas using SwaggerUI.

GitHub (👨‍💻 7 · 🔀 11 · 📋 15 - 20% open · ⏱️ 07.10.2023)

PyPi (📥 62K / month):

 pip install mkdocs-render-swagger-plugin

Add to mkdocs.yml:
```
plugins:
  - render_swagger
```

Publisher for MkDocs - obsidian - 🥈15 · ⭐ 28 · MIT ·
Obsidian.md integration including with support for wiki links, callouts, etc.

GitHub (👨‍💻 2 · 🔀 1 · 📥 9 · 📦 31 · 📋 13 - 30% open · ⏱️ 21.04.2024)
PyPi (📥 2K / month):
```
 pip install mkdocs-publisher
```
Add to mkdocs.yml:
```
plugins:
  - pub-obsidian
```

mkdocs-coverage - 🥈15 · ⭐ 16 · ISC ·
MkDocs plugin to integrate your coverage HTML report into your site.

GitHub (🔀 1 · 📦 200 · 📋 10 - 50% open · ⏱️ 18.01.2024)
PyPi (📥 16K / month):
```
 pip install mkdocs-coverage
```
Add to mkdocs.yml:
```
plugins:
  - coverage
```

MkDocs Backend for Foliant - 🥉12 · ⭐ 3 · 💤 · MIT
MkDocs backend for Foliant.

GitHub (👨‍💻 5 · 🔀 3 · 📦 31 · ⏱️ 12.12.2022)
PyPi (📥 380 / month):
```
 pip install foliantcontrib.mkdocs
```

swagger - 🥉6 · ⭐ 30 · 💤 · MIT ·
MkDocs plugin for render swagger into docs.

GitHub (🔀 6 · 📋 5 - 60% open · ⏱️ 06.10.2019)
Add to mkdocs.yml:
```
plugins:
  - swagger
```

factsheet - 🥉6 · ⭐ 3 · 💤 · MIT ·
Generate overviews from YAML descriptions, intended for micro-services and their deployments.

GitHub (👨‍💻 4 · 🔀 1 · ⏱️ 08.02.2023)
Add to mkdocs.yml:
```
plugins:
  - factsheet
```

MkDocs Dependency License Information - 🥉4 · ⭐ 2 · 🐣 · MIT ·
mkdocs extension to visualise package dependencies license information.

GitHub (👨‍💻 2 · ⏱️ 02.01.2024)
PyPi (📥 29 / month):
```
 pip install mkdocs-licenseinfo
```
Add to mkdocs.yml:
```
plugins:
  - mkdocs_licenseinfo
```

🌍 Internationalization & localization

static-i18n - 🥇23 · ⭐ 210 · MIT ·
MkDocs i18n plugin using static translation markdown files.

GitHub (👨‍💻 10 · 🔀 35 · 📦 1K · 📋 140 - 14% open · ⏱️ 02.05.2024)
PyPi (📥 31K / month):
```
 pip install mkdocs-static-i18n
```
Add to mkdocs.yml:
```
plugins:
  - i18n
```

mkdocs-mdpo - 🥉11 · ⭐ 5 · 💤 · BSD-3 ·
Mkdocs translation plugin using PO files.

GitHub (👨‍💻 3 · 🔀 3 · 📥 150 · 📋 37 - 35% open · ⏱️ 03.01.2023)
PyPi (📥 410 / month):
```
 pip install mkdocs-mdpo-plugin
```
Add to mkdocs.yml:
```
plugins:
  - mdpo
```

Mkdocs translations plugin - 🥉1 · ❗Unlicensed ·
Internationalization plugin for mkdocs.

PyPi (📥 19 / month):
```
 pip install mkdocs-translations
```
Add to mkdocs.yml:
```
plugins:
  - translations
```

🔗 Links & references

mkdocs-redirects - 🥇22 · ⭐ 150 · MIT ·
Open source plugin for Mkdocs page redirects.

GitHub (👨‍💻 13 · 🔀 20 · 📦 3.4K · 📋 31 - 38% open · ⏱️ 03.02.2024)
PyPi (📥 210K / month):
```
 pip install mkdocs-redirects
```
Add to mkdocs.yml:
```
plugins:
  - redirects
```

htmlproofer - 🥇22 · ⭐ 37 · MIT ·
A MkDocs plugin that validates URL in rendered html files.

GitHub (👨‍💻 15 · 🔀 15 · 📦 340 · 📋 34 - 8% open · ⏱️ 15.04.2024)
PyPi (📥 43K / month):
```
 pip install mkdocs-htmlproofer-plugin
```
Add to mkdocs.yml:
```
plugins:
  - htmlproofer
```

bibtex - 🥇21 · ⭐ 65 · ❗️BSD-3-Clause-LBNL ·
A MkDocs plugin for citation management using bibtex.

GitHub (👨‍💻 13 · 🔀 18 · 📦 260 · 📋 43 - 25% open · ⏱️ 04.04.2024)
PyPi (📥 6.5K / month):
```
 pip install mkdocs-bibtex
```
Add to mkdocs.yml:
```
plugins:
  - bibtex
```

autolinks - 🥈18 · ⭐ 75 · MIT ·
An MkDocs plugin that automagically generates relative links between markdown pages.

GitHub (👨‍💻 10 · 🔀 16 · 📦 390 · 📋 17 - 47% open · ⏱️ 04.08.2023)
PyPi (📥 55K / month):
```
 pip install mkdocs-autolinks-plugin
```
Add to mkdocs.yml:
```
plugins:
  - autolinks
```

autorefs - 🥈17 · ⭐ 38 · ISC ·
Automatically link across pages in MkDocs.

GitHub (👨‍💻 6 · 🔀 5 · 📋 16 - 37% open · ⏱️ 29.02.2024)
PyPi (📥 920K / month):
```
 pip install mkdocs-autorefs
```
Add to mkdocs.yml:
```
plugins:
  - autorefs
```

mkdocs-alias-plugin - 🥈15 · ⭐ 10 · MIT ·
An MkDocs plugin allowing links to your pages using a custom alias.

GitHub (👨‍💻 3 · 🔀 2 · 📦 14 · 📋 9 - 22% open · ⏱️ 22.04.2024)
PyPi (📥 2K / month):
```
 pip install mkdocs-alias-plugin
```
Add to mkdocs.yml:
```
plugins:
  - alias
```

ezlinks - 🥈14 · ⭐ 32 · 💤 · MIT ·
Plugin for mkdocs which enables easier linking between pages.

GitHub (🔀 13 · 📥 140 · 📦 100 · 📋 24 - 41% open · ⏱️ 24.01.2022)
PyPi (📥 4.2K / month):
```
 pip install mkdocs-ezlinks-plugin
```
Add to mkdocs.yml:
```
plugins:
  - ezlinks
```

Autolink References - 🥈13 · ⭐ 16 · MIT ·
mkdocs plugin to provides GitHub like autolink references in Mkdocs.

GitHub (👨‍💻 3 · 🔀 5 · 📦 7 · 📋 4 - 25% open · ⏱️ 28.12.2023)

PyPi (📥 6.5K / month):

 pip install autolink-references-mkdocs-plugin

Add to mkdocs.yml:
```
plugins:
  - autolink_references
```

roamlinks - 🥈12 · ⭐ 47 · MIT ·
An MkDocs plugin that automagically generates relative links between markdown pages.

GitHub (👨‍💻 9 · 🔀 13 · ⏱️ 08.06.2023)
PyPi (📥 10K / month):
```
 pip install mkdocs-roamlinks-plugin
```
Add to mkdocs.yml:
```
plugins:
  - roamlinks
```

mkdocs-open-in-new-tab - 🥈12 · ⭐ 19 · MIT ·
This plugin adds JS to open outgoing links and PDFs in a new tab.

GitHub (🔀 1 · 📦 160 · 📋 2 - 50% open · ⏱️ 24.10.2023)
PyPi (📥 17K / month):
```
 pip install mkdocs-open-in-new-tab
```
Add to mkdocs.yml:
```
plugins:
  - open-in-new-tab
```

unused-files - 🥉11 · ⭐ 8 · MIT ·
An MkDocs plugin to find unused (orphaned) files in your project.

GitHub (👨‍💻 2 · 🔀 1 · 📦 19 · ⏱️ 17.07.2023)
PyPi (📥 2.8K / month):
```
 pip install mkdocs-unused-files
```
Add to mkdocs.yml:
```
plugins:
  - unused_files
```

ezglossary - 🥉10 · ⭐ 7 · MIT ·
Glossary support for mkdocs.

GitHub (📋 15 - 6% open · ⏱️ 24.04.2024)
PyPi (📥 2.5K / month):
```
 pip install mkdocs-ezglossary-plugin
```
Add to mkdocs.yml:
```
plugins:
  - ezglossary
```

mkdocs-site-urls - 🥉9 · ⭐ 13 · MIT ·
A MkDocs plugin that adds support for site-relative `site:` URLs.

GitHub (🔀 1 · 📦 9 · 📋 2 - 50% open · ⏱️ 31.07.2023)
PyPi (📥 3.2K / month):
```
 pip install mkdocs-site-urls
```
Add to mkdocs.yml:
```
plugins:
  - site-urls
```

link-marker - 🥉9 · ⭐ 4 · MIT ·
MkDocs plugin for marking links e.g. external ones or mails.

GitHub (👨‍💻 2 · 🔀 1 · 📦 8 · 📋 4 - 50% open · ⏱️ 25.02.2024)
PyPi (📥 2K / month):
```
 pip install mkdocs-link-marker
```
Add to mkdocs.yml:
```
plugins:
  - link-marker
```

abs-to-rel - 🥉9 · ⭐ 3 · 💤 · MIT ·
MkDocs plugin for converting absolute links to relative ones.

GitHub (👨‍💻 2 · 🔀 3 · 📦 21 · ⏱️ 03.03.2020)
PyPi (📥 3.4K / month):
```
 pip install mkdocs-abs-rel-plugin
```
Add to mkdocs.yml:
```
plugins:
  - abs-to-rel
```

Wikilink Plus - 🥉8 · ⭐ 14 · 💤 · ❗Unlicensed ·
A wikilink extension for Python Markdown.

GitHub (👨‍💻 5 · 🔀 3 · ⏱️ 26.07.2022)
PyPi (📥 3.6K / month):
```
 pip install mdx-wikilink-plus
```

Add to mkdocs.yml:

markdown_extensions:
  - mdx_wikilink_plus

tooltipster-links - 🥉8 · ⭐ 6 · 💤 · MIT ·
An MkDocs plugin that adds tooltips to preview the content of page links using tooltipster.

GitHub (🔀 1 · 📦 22 · ⏱️ 29.07.2020)

PyPi (📥 130 / month):

 pip install mkdocs-tooltipster-links-plugin

Add to mkdocs.yml:
```
plugins:
  - tooltipster-links
```

webcontext - 🥉5 · ⭐ 1 · MIT ·
Mkdocs plugin for converting absolute paths to webcontext aware paths using the configured webcontext context.

GitHub (👨‍💻 2 · 🔀 1 · 📥 6 · 📦 4 · ⏱️ 25.05.2023)
PyPi (📥 120 / month):
```
 pip install mkdocs-webcontext-plugin
```
Add to mkdocs.yml:
```
plugins:
  - webcontext
```

emailprotect - 🥉4 · ⭐ 3 · 💤 · MIT ·
A MkDocs plugin that tries to obscure email-addresses from address-harvesting spam-bots.

GitHub (⏱️ 21.01.2020)
Add to mkdocs.yml:
```
plugins:
  - emailprotect
```

Mkdocs-Addresses - 🥉4 · ❗Unlicensed ·
Mkdocs plugin, building automatically the appropriate relative paths (to images, links, anchors, ...) using..

PyPi (📥 270 / month):
```
 pip install mkdocs-addresses
```
GitLab (🔀 0 · ⏱️ 13.07.2023)
Add to mkdocs.yml:
```
plugins:
  - mkdocs-addresses
```

alternate-link - 🥉3 · ⭐ 4 · 💤 · MIT ·
An MkDocs plugin that simplifies internal links creation.

GitHub (👨‍💻 3 · 🔀 2 · ⏱️ 14.02.2021)
Add to mkdocs.yml:
```
plugins:
  - alternate-link
```

🧩 Markdown extensions

PyMdown Extensions - 🥇33 · ⭐ 900 · 📈 · ❗Unlicensed ·
Extensions for Python Markdown.

GitHub (👨‍💻 44 · 🔀 240 · 📦 31K · 📋 360 - 1% open · ⏱️ 22.04.2024)
PyPi (📥 3.7M / month):
```
 pip install pymdown-extensions
```

Add to mkdocs.yml:

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

markdown-callouts - 🥇18 · ⭐ 23 · MIT ·
Markdown extension: a classier syntax for admonitions.

GitHub (🔀 12 · 📦 200 · 📋 11 - 27% open · ⏱️ 03.02.2024)
PyPi (📥 28K / month):
```
 pip install markdown-callouts
```

Add to mkdocs.yml:

markdown_extensions:
  - callouts
  - github-callouts

mkdocs-callouts - 🥇17 · ⭐ 20 · MIT ·
A simple MkDocs plugin that converts Obsidian callout blocks to mkdocs supported Admonitions.

GitHub (👨‍💻 2 · 🔀 1 · 📦 1.1K · ⏱️ 05.03.2024)
PyPi (📥 7K / month):
```
 pip install mkdocs-callouts
```
Add to mkdocs.yml:
```
plugins:
  - callouts
```

YAML metadata - 🥈16 · ⭐ 19 · MIT ·
YAML metadata extension for Python-Markdown.

GitHub (👨‍💻 7 · 🔀 4 · 📦 80 · 📋 10 - 30% open · ⏱️ 28.01.2024)

PyPi (📥 1.4K / month):

 pip install markdown-full-yaml-metadata

Add to mkdocs.yml:

markdown_extensions:
  - full_yaml_metadata

Math extension - 🥈15 · ⭐ 120 · 💤 · BSD-3 ·
Math extension for Python-Markdown.

GitHub (👨‍💻 8 · 🔀 25 · 📋 24 - 8% open · ⏱️ 12.08.2022)
PyPi (📥 240K / month):
```
 pip install python-markdown-math
```
Add to mkdocs.yml:
```
markdown_extensions:
  - mdx_math
```

Mdx Truly Sane Lists - 🥈14 · ⭐ 78 · 💤 · MIT ·
Extension for Python-Markdown that makes lists truly sane. Custom indents for nested lists and fix for messy..

GitHub (👨‍💻 4 · 🔀 9 · 📋 15 - 46% open · ⏱️ 19.07.2022)
PyPi (📥 360K / month):
```
 pip install mdx-truly-sane-lists
```

Add to mkdocs.yml:

markdown_extensions:
  - mdx_truly_sane_lists

Markdown Inline Graphviz - 🥈14 · ⭐ 4 · MIT ·
Render inline graphs with Markdown and Graphviz.

GitHub (👨‍💻 9 · 🔀 8 · ⏱️ 16.01.2024)

PyPi (📥 200K / month):

 pip install markdown-inline-graphviz-extension

Add to mkdocs.yml:

markdown_extensions:
  - markdown_inline_graphviz

Markdown Checklist - 🥈11 · ⭐ 77 · 💤 · MIT ·
Python Markdown extension for lists of tasks with checkboxes.

GitHub (👨‍💻 2 · 🔀 31 · 📋 8 - 12% open · ⏱️ 29.07.2022)
PyPi (📥 5.4K / month):
```
 pip install markdown-checklist
```

Add to mkdocs.yml:

markdown_extensions:
  - markdown_checklist.extension

MarkdownSubscript - 🥈11 · ⭐ 3 · 💤 · BSD-2 ·
An extension to the Python Markdown package enabling subscript text.

GitHub (👨‍💻 2 · 🔀 1 · 📦 54 · 📋 5 - 40% open · ⏱️ 02.12.2018)
PyPi (📥 270 / month):
```
 pip install MarkdownSubscript
```
Add to mkdocs.yml:
```
markdown_extensions:
  - subscript
```

MarkdownSuperscript - 🥈11 · ⭐ 2 · 💤 · BSD-2 ·
An extension to the Python Markdown package enabling superscript text.

GitHub (👨‍💻 2 · 🔀 3 · 📦 43 · 📋 4 - 25% open · ⏱️ 02.12.2018)
PyPi (📥 900 / month):
```
 pip install MarkdownSuperscript
```
Add to mkdocs.yml:
```
markdown_extensions:
  - superscript
```

Breakless Lists - 🥈9 · ⭐ 5 · 💤 · MIT ·
Python markdown breakless lists extension.

GitHub (🔀 2 · 📋 2 - 50% open · ⏱️ 08.10.2020)
PyPi (📥 20K / month):
```
 pip install mdx-breakless-lists
```

Add to mkdocs.yml:

markdown_extensions:
  - mdx_breakless_lists

markdown-emdash - 🥉8 · ⭐ 3 · MIT ·
Emdash extension for python-markdown.

GitHub (🔀 1 · 📦 33 · ⏱️ 18.05.2023)
PyPi (📥 200 / month):
```
 pip install markdown-emdash
```
Add to mkdocs.yml:
```
markdown_extensions:
  - mdx_emdash
```

markdown-icons - 🥉7 · ⭐ 11 · 💤 · ❗Unlicensed ·
Easily display icon fonts in markdown.

GitHub (👨‍💻 4 · 🔀 11 · 📋 7 - 42% open · ⏱️ 09.12.2018)
PyPi (📥 43 / month):
```
 pip install markdown-iconfonts
```
Add to mkdocs.yml:
```
markdown_extensions:
  - iconfonts
```

caption - 🥉7 · ⭐ 9 · 💤 · ❗️GPL-3.0 ·

GitHub (👨‍💻 3 · 🔀 2 · 📦 49 · 📋 7 - 85% open · ⏱️ 29.01.2023)

Add to mkdocs.yml:

markdown_extensions:
  - caption
  - image_captions
  - table_captions

python-asciimathml - 🥉7 · ⭐ 4 · 💤 · ❗️GPL-3.0 ·
python ASCIIMathML to Presentation MathML translator.

GitHub (👨‍💻 8 · 🔀 4 · ⏱️ 04.04.2017)
PyPi (📥 67 / month):
```
 pip install asciimathml
```

Add to mkdocs.yml:

markdown_extensions:
  - mdx_asciimathml

markdown-katex - 🥉6 · ⭐ 11 · 💤 · ❗Unlicensed ·
KaTeX extension for Python Markdown.

PyPi (📥 3.5K / month):
```
 pip install markdown-katex
```
GitLab (🔀 5 · 📋 17 - 23% open · ⏱️ 14.05.2019)
Add to mkdocs.yml:
```
markdown_extensions:
  - markdown_katex
```

mkpatcher - 🥉6 · ⭐ 2 · 💤 · Apache-2 ·
Python-Markdown extension allowing arbitrary scripts to modify MkDocs input files.

GitHub (📦 4 · ⏱️ 26.04.2020)
PyPi (📥 130 / month):
```
 pip install mkpatcher
```
Add to mkdocs.yml:
```
markdown_extensions:
  - mkpatcher
```

Tweetable quotes - 🥉5 · ⭐ 15 · 💤 · MIT ·
Python-Markdown extension to embed tweetable quotes into your blog posts.

GitHub (🔀 1 · 📦 2 · ⏱️ 25.03.2019)
PyPi (📥 42 / month):
```
 pip install markdown-tweetable
```

Add to mkdocs.yml:

markdown_extensions:
  - tweetable.extension

HEARTBEATS Flavored Markdown - 🥉5 · ⭐ 14 · 💤 · ❗Unlicensed ·
HEARTBEATS Flavored Markdown extension.

GitHub (👨‍💻 2 · 🔀 1 · 📦 8 · ⏱️ 01.03.2018)
PyPi (📥 390 / month):
```
 pip install hbfm
```

Add to mkdocs.yml:

markdown_extensions:
  - hbfm.inline_coloring
  - hbfm.inline_list
  - hbfm.number_headers
  - hbfm.quote_uri_hash

Markdown Grid Tables - 🥉5 · ⭐ 1 · 💤 · ❗Unlicensed ·
[Python-Markdown](https://python-markdown.github.io/) [extension](https://python-markdown.github.io/extensions/api/)..

PyPi (📥 4.2K / month):
```
 pip install markdown-grid-tables
```
GitLab (🔀 4 · ⏱️ 09.02.2022)

Add to mkdocs.yml:

markdown_extensions:
  - markdown_grid_tables

Cite Extension - 🥉4 · ⭐ 6 · 💤 · ❗Unlicensed ·
Python-Markdown extension to support the cite tag.

GitHub (🔀 3 · ⏱️ 21.04.2012)
PyPi (📥 14 / month):
```
 pip install mdx-cite
```
Add to mkdocs.yml:
```
markdown_extensions:
  - mdx_cite
```

KBD Extension - 🥉4 · ⭐ 2 · 💤 · MIT ·
KBD Extension for Python-Markdown.

GitHub (🔀 1 · 📦 7 · ⏱️ 08.06.2020)
PyPi (📥 110 / month):
```
 pip install kbdextension
```
Add to mkdocs.yml:
```
markdown_extensions:
  - kbdextension
```

markdown_sub_sup - 🥉4 · ⭐ 1 · 💤 · ❗️LGPL-3.0 ·
A python markdown extension for add sub and sup support.

GitHub (⏱️ 24.03.2023)
PyPi (📥 46 / month):
```
 pip install markdown-sub-sup
```

Add to mkdocs.yml:

markdown_extensions:
  - markdown_sub_sup

markdown-del-ins - 🥉3 · ⭐ 12 · 💤 · ❗Unlicensed ·
Markdown extension to support the del and ins tags.

GitHub (👨‍💻 2 · ⏱️ 09.01.2020)
PyPi (📥 1.1K / month):
```
 pip install markdown-del-ins
```

Add to mkdocs.yml:

markdown_extensions:
  - markdown_del_ins

Semantic WikiLinks Extension - 🥉2 · ⭐ 8 · 💤 · ❗Unlicensed ·
Python-Markdown extension to add support for semantic (wiki)links (RDFa).

GitHub (🔀 1 · ⏱️ 15.08.2012)
PyPi (📥 17 / month):
```
 pip install mdx-semanticwikilinks
```

Add to mkdocs.yml:

markdown_extensions:
  - mdx_semanticwikilinks

Semantic Data Extension - 🥉2 · ⭐ 5 · 💤 · ❗Unlicensed ·
Python-Markdown extension to add support for semantic data (RDFa).

GitHub (🔀 1 · ⏱️ 05.11.2012)
PyPi (📥 19 / month):
```
 pip install mdx-semanticdata
```

Add to mkdocs.yml:

markdown_extensions:
  - mdx_semanticdata

Django Static Image · ❗Unlicensed ·

PyPi (📥 14 / month):

 pip install markdown-djangostaticimage

Add to mkdocs.yml:

markdown_extensions:
  - django_static_image

🧭 Navigation & page building

awesome-pages - 🥇25 · ⭐ 440 · MIT ·
An MkDocs plugin that simplifies configuring page titles and their order.

GitHub (👨‍💻 8 · 🔀 33 · 📦 4.1K · 📋 81 - 22% open · ⏱️ 09.03.2024)

PyPi (📥 240K / month):

 pip install mkdocs-awesome-pages-plugin

Add to mkdocs.yml:
```
plugins:
  - awesome-pages
```

encryptcontent - 🥇23 · ⭐ 110 · MIT ·
A MkDocs plugin that encrypt/decrypt markdown content with AES.

GitHub (👨‍💻 5 · 🔀 13 · 📥 85 · 📦 1.1K · 📋 61 - 3% open · ⏱️ 13.04.2024)

PyPi (📥 8.5K / month):

 pip install mkdocs-encryptcontent-plugin

Add to mkdocs.yml:
```
plugins:
  - encryptcontent
```

section-index - 🥇22 · ⭐ 72 · MIT ·
MkDocs plugin to allow clickable sections that lead to an index page.

GitHub (👨‍💻 3 · 🔀 7 · 📦 1.5K · 📋 17 - 23% open · ⏱️ 20.04.2024)
PyPi (📥 210K / month):
```
 pip install mkdocs-section-index
```
Add to mkdocs.yml:
```
plugins:
  - section-index
```

literate-nav - 🥈20 · ⭐ 72 · MIT ·
MkDocs plugin to specify the navigation in Markdown instead of YAML.

GitHub (🔀 8 · 📦 1.7K · 📋 26 - 38% open · ⏱️ 27.04.2024)
PyPi (📥 200K / month):
```
 pip install mkdocs-literate-nav
```
Add to mkdocs.yml:
```
plugins:
  - literate-nav
```

mkdocs-simple-hooks - 🥈18 · ⭐ 56 · MIT ·
Define your own hooks for mkdocs, without having to create a new package.

GitHub (👨‍💻 5 · 🔀 4 · 📥 32 · 📦 1.5K · ⏱️ 14.11.2023)
PyPi (📥 43K / month):
```
 pip install mkdocs-simple-hooks
```
Add to mkdocs.yml:
```
plugins:
  - mkdocs-simple-hooks
```

exclude - 🥈17 · ⭐ 84 · 💤 · Apache-2 ·
A mkdocs plugin that lets you exclude files or trees from your output.

GitHub (🔀 10 · 📦 1.9K · 📋 12 - 75% open · ⏱️ 20.02.2019)
PyPi (📥 120K / month):
```
 pip install mkdocs-exclude
```
Add to mkdocs.yml:
```
plugins:
  - exclude
```

mkdocs-gallery - 🥈16 · ⭐ 30 · BSD-3 ·
Same features as sphinx-gallery (https://sphinx-gallery.github.io/) but on mkdocs (https://www.mkdocs.org/) (no sphinx..

GitHub (👨‍💻 9 · 🔀 13 · 📋 65 - 40% open · ⏱️ 15.03.2024)
PyPi (📥 2.4K / month):
```
 pip install mkdocs-gallery
```
Add to mkdocs.yml:
```
plugins:
  - gallery
```

file-filter - 🥈16 · ⭐ 7 · MIT ·
A MkDocs plugin that lets you exclude/include docs files using globs, regexes, gitignore-style file and..

GitHub (👨‍💻 4 · 🔀 3 · 📥 37 · 📦 6 · 📋 11 - 27% open · ⏱️ 13.03.2024)
PyPi (📥 6.8K / month):
```
 pip install mkdocs-file-filter-plugin
```
Add to mkdocs.yml:
```
plugins:
  - file-filter
```

Publisher for MkDocs - meta - 🥈15 · ⭐ 28 · MIT ·
Navigation and page building based on files metadata.

GitHub (👨‍💻 2 · 🔀 1 · 📥 9 · 📦 31 · 📋 13 - 30% open · ⏱️ 21.04.2024)
PyPi (📥 2K / month):
```
 pip install mkdocs-publisher
```
Add to mkdocs.yml:
```
plugins:
  - pub-meta
```

mkdocs-nav-weight - 🥈12 · ⭐ 8 · MIT ·
A simple mkdocs plugin, enables to organize Navigation in a more markdownic way.

GitHub (👨‍💻 3 · 🔀 2 · 📦 49 · ⏱️ 17.11.2023)
PyPi (📥 7.2K / month):
```
 pip install mkdocs-nav-weight
```
Add to mkdocs.yml:
```
plugins:
  - mkdocs-nav-weight
```

mkdocs-categories-plugin - 🥈11 · ⭐ 11 · MIT ·
An MkDocs plugin allowing for categorization of wiki pages.

GitHub (📦 14 · ⏱️ 22.04.2024)
PyPi (📥 600 / month):
```
 pip install mkdocs-categories-plugin
```
Add to mkdocs.yml:
```
plugins:
  - categories
```

mkdocs-pagetree-plugin - 🥈11 · ⭐ 1 · 🐣 · MIT ·
MkDocs plugin that allows you to display the page tree. Like `sitemap.xml`, but for humans.

GitHub (📦 5 · 📋 9 - 55% open · ⏱️ 20.04.2024)
PyPi (📥 430 / month):
```
 pip install mkdocs-pagetree-plugin
```
Add to mkdocs.yml:
```
plugins:
  - pagetree
```

MkRefs - 🥉10 · ⭐ 28 · MIT ·
MkDocs plugin to generate semantic reference Markdown pages from a knowledge graph.

GitHub (👨‍💻 2 · 📦 3 · ⏱️ 31.08.2023)
PyPi (📥 61 / month):
```
 pip install mkrefs
```
Add to mkdocs.yml:
```
plugins:
  - mkrefs
```

toc-sidebar - 🥉10 · ⭐ 4 · 💤 · MIT ·
An MkDocs plugin that allows users to add additional content to the ToC sidebar using the Material theme.

GitHub (👨‍💻 2 · 🔀 3 · 📦 35 · ⏱️ 11.01.2020)
PyPi (📥 5.7K / month):
```
 pip install mkdocs-toc-sidebar-plugin
```
Add to mkdocs.yml:
```
plugins:
  - toc-sidebar
```

include directory to navigation - 🥉9 · ⭐ 24 · 💤 · ❗Unlicensed ·
Simple MKDocs plugin than permit to fetch and replace directory in navigation.

GitHub (🔀 1 · 📥 8 · 📋 4 - 50% open · ⏱️ 01.03.2022)
PyPi (📥 72K / month):
```
 pip install mkdocs-include-dir-to-nav
```
Add to mkdocs.yml:
```
plugins:
  - include_dir_to_nav
```

vim-md-tags - 🥉9 · ⭐ 4 · 💤 · MIT ·
An MkDocs plugin that creates a vim tag file of all markdown files.

GitHub (👨‍💻 4 · 🔀 1 · 📦 10 · ⏱️ 08.05.2020)
PyPi (📥 140 / month):
```
 pip install mkdocs-vim-md-tags-plugin
```
Add to mkdocs.yml:
```
plugins:
  - vim-md-tags
```

mkdocs-nav-enhancements - 🥉9 · ⭐ 3 · 💤 · MIT ·
WIP plugin for working with titles of pages in MkDocs.

GitHub (📦 32 · ⏱️ 24.07.2019)
PyPi (📥 5.2K / month):
```
 pip install mkdocs-nav-enhancements
```
Add to mkdocs.yml:
```
plugins:
  - mkdocs-nav-enhancements
```

mkdocs-live-edit-plugin - 🥉8 · ⭐ 9 · MIT ·
An MkDocs plugin that allows editing pages directly from the browser.

GitHub (👨‍💻 2 · 🔀 1 · 📦 3 · 📋 3 - 33% open · ⏱️ 07.03.2024)
PyPi (📥 120 / month):
```
 pip install mkdocs-live-edit-plugin
```
Add to mkdocs.yml:
```
plugins:
  - live-edit
```

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 (👨‍💻 3 · 🔀 3 · 📋 3 - 66% open · ⏱️ 23.06.2021)
PyPi (📥 1.6K / month):
```
 pip install mkdocs-schema-reader
```
Add to mkdocs.yml:
```
plugins:
  - schema_reader
```

select-files - 🥉6 · 💤 · Apache-2 ·
Filter pages for assignments.

GitHub (📦 7 · ⏱️ 05.09.2019)
PyPi (📥 44 / month):
```
 pip install mkdocs-select-files
```
Add to mkdocs.yml:
```
plugins:
  - select-files
```

SWAN Gallery - 🥉5 · ⭐ 1 · ❗️AGPL-3.0 ·
MkDocs plugin to generate a SWAN Gallery.

GitHub (👨‍💻 2 · 📦 1 · ⏱️ 20.07.2023)
PyPi (📥 67 / month):
```
 pip install mkdocs-swangallery
```
Add to mkdocs.yml:
```
plugins:
  - swangallery
```

awesome-list - 🥉4 · ⭐ 4 · 💤 · MIT ·
MkDocs Plugin to inject social media cards for each entry in an awesome-list.

GitHub (⏱️ 26.07.2019)
Add to mkdocs.yml:
```
plugins:
  - awesome-list
```

mkdocs-copy - 🥉4 · ⭐ 4 · 💤 · MIT ·
A MkDocs plugin that lets you copy (and maybe transform) arbitrary doc files to the build.

GitHub (📥 5 · ⏱️ 21.09.2021)
PyPi (📥 26 / month):
```
 pip install mkdocs-copy
```
Add to mkdocs.yml:
```
plugins:
  - copy
```

mkdocs-title-casing-plugin - 🥉4 · ⭐ 2 · ❗️GPL-3.0 ·
A lightweight mkdocs plugin to add title casing to all mkdocs pages and sections.

GitHub (⏱️ 02.09.2023)

PyPi (📥 370 / month):

 pip install mkdocs-title-casing-plugin

Add to mkdocs.yml:
```
plugins:
  - title-casing
```

pagenav-generator - 🥉2 · ⭐ 3 · 💤 · MIT ·
Little something to automatically generate a Navigation within a page itself. Depends on Awesome-pages.

GitHub (👨‍💻 2 · 🔀 1 · ⏱️ 17.04.2022)
Add to mkdocs.yml:
```
plugins:
  - pagenav-generator
```

mkdocs-pug - 🥉1 · 💤 · ❗Unlicensed
Use pug templates with your mkdocs template.

GitHub (⏱️ 20.10.2021)
PyPi (📥 13 / month):
```
 pip install mkdocs-pug
```

✅ Quality checks (code blocks, spelling, etc.)

mkdocs-spellcheck - 🥇16 · ⭐ 11 · ISC ·
A spell checker plugin for MkDocs.

GitHub (👨‍💻 3 · 🔀 3 · 📦 36 · 📋 18 - 55% open · ⏱️ 23.03.2024)
PyPi (📥 9.4K / month):
```
 pip install mkdocs-spellcheck
```
Add to mkdocs.yml:
```
plugins:
  - spellcheck
```

mktestdocs - 🥈15 · ⭐ 100 · 💤 · Apache-2
Run pytest against markdown files/docstrings.

GitHub (👨‍💻 3 · 🔀 6 · 📦 54 · 📋 3 - 66% open · ⏱️ 27.04.2023)
PyPi (📥 4.6K / month):
```
 pip install mktestdocs
```

Link Checker - 🥉9 · ⭐ 9 · 💤 · MIT
Python asyncio + aiohttp Markdown *.md URL link checker: 10,000 files/second.

GitHub (👨‍💻 5 · 🔀 4 · ⏱️ 24.08.2021)
PyPi (📥 2K / month):
```
 pip install mkdocs-linkcheck
```

mkdocs-code-validator - 🥉9 · ⭐ 1 · MIT ·
Checks Markdown code blocks in a MkDocs site against user-defined actions.

GitHub (📦 13 · ⏱️ 27.04.2024)
PyPi (📥 450 / month):
```
 pip install mkdocs-code-validator
```
Add to mkdocs.yml:
```
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 (👨‍💻 6 · ⏱️ 16.12.2021)
PyPi (📥 44 / month):
```
 pip install mkdocs-codecheck
```

🔍 Search & tables of content

exclude-search - 🥇17 · ⭐ 27 · MIT ·
A mkdocs plugin that excludes selected chapters from the docs search index.

GitHub (👨‍💻 5 · 🔀 2 · 📥 8 · 📦 370 · ⏱️ 04.12.2023)
PyPi (📥 19K / month):
```
 pip install mkdocs-exclude-search
```
Add to mkdocs.yml:
```
plugins:
  - exclude-search
```

localsearch - 🥈16 · ⭐ 31 · 💤 · MIT ·
A MkDocs plugin to make the native search plugin work locally (file:// protocol).

GitHub (👨‍💻 6 · 🔀 7 · 📦 66 · ⏱️ 02.01.2023)
PyPi (📥 4.8K / month):
```
 pip install mkdocs-localsearch
```
Add to mkdocs.yml:
```
plugins:
  - localsearch
```

tags - 🥉9 · ⭐ 42 · 💤 · MIT ·
Processes tags in yaml metadata.

GitHub (👨‍💻 3 · 🔀 19 · 📋 14 - 42% open · ⏱️ 02.09.2021)
PyPi (📥 920 / month):
```
 pip install mkdocs-plugin-tags
```
Add to mkdocs.yml:
```
plugins:
  - tags
```

extract listings - 🥉6 · 🐣 · MIT ·
Generate a page with all listings and/or a search page for listings.

GitHub (⏱️ 22.02.2024)

PyPi (📥 680 / month):

 pip install mkdocs-extract-listings-plugin

Add to mkdocs.yml:
```
plugins:
  - extract_listings
```

🍱 Site conversion (PDF/ePUB/etc.)

pdf-export - 🥇22 · ⭐ 310 · 💤 · MIT ·
An MkDocs plugin to export content pages as PDF files.

GitHub (👨‍💻 11 · 🔀 43 · 📦 900 · 📋 88 - 47% open · ⏱️ 05.10.2021)
PyPi (📥 29K / month):
```
 pip install mkdocs-pdf-export-plugin
```
Add to mkdocs.yml:
```
plugins:
  - pdf-export
```

mkdocs-with-pdf - 🥇22 · ⭐ 300 · 💤 · MIT ·
Generate a single PDF file from MkDocs repository.

GitHub (👨‍💻 6 · 🔀 73 · 📦 500 · 📋 100 - 56% open · ⏱️ 14.10.2021)
PyPi (📥 47K / month):
```
 pip install mkdocs-with-pdf
```
Add to mkdocs.yml:
```
plugins:
  - with-pdf
```

print-site - 🥇22 · ⭐ 120 · MIT ·
MkDocs Plugin that adds an additional page that combines all pages, allowing easy exports to PDF and standalone HTML.

GitHub (👨‍💻 7 · 🔀 18 · 📦 300 · 📋 88 - 15% open · ⏱️ 10.04.2024)
PyPi (📥 22K / month):
```
 pip install mkdocs-print-site-plugin
```
Add to mkdocs.yml:
```
plugins:
  - print-site
```

mkpdfs - 🥈16 · ⭐ 100 · 💤 · ❗️GPL-3.0 ·
Converts your mkdocs documentation in PDF, to be shared with users.

GitHub (👨‍💻 8 · 🔀 30 · 📥 34 · 📦 55 · 📋 39 - 30% open · ⏱️ 11.08.2021)
PyPi (📥 920 / month):
```
 pip install mkpdfs-mkdocs
```
Add to mkdocs.yml:
```
plugins:
  - mkpdfs
```

mkdocs-pandoc - 🥈14 · ⭐ 110 · 💤 · Apache-2
[unmaintained] mkdocs - pandoc converter: use this fork https://github.com/twardoch/mkdocs-combine.

GitHub (👨‍💻 4 · 🔀 22 · 📦 50 · 📋 23 - 56% open · ⏱️ 14.03.2016)
PyPi (📥 370 / month):
```
 pip install mkdocs-pandoc
```

mkdocs-exporter - 🥉13 · ⭐ 52 · 📈 · MIT ·
A plugin for MkDocs that exports your pages as PDF documents.

GitHub (👨‍💻 2 · 📦 3 · 📋 19 - 15% open · ⏱️ 24.03.2024)
PyPi (📥 1.2K / month):
```
 pip install mkdocs-exporter
```

Add to mkdocs.yml:

plugins:
  - exporter
  - exporter-pdf
  - exporter-extras

pdf-with-js - 🥉12 · ⭐ 7 · 💤 · MIT ·
A MkDocs plugin that exports your documentation as PDF with rendered JavaScript content.

GitHub (👨‍💻 4 · 🔀 2 · 📦 11 · ⏱️ 23.07.2021)
PyPi (📥 2K / month):
```
 pip install mkdocs-pdf-with-js-plugin
```
Add to mkdocs.yml:
```
plugins:
  - pdf-with-js
```

mk2pdf-export - 🥉6 · ⭐ 7 · 💤 · MIT ·
The plugin is based on https://github.com/zhaoterryy/mkdocs-pdf-export-plugin/ ,the main change is use pandoc to..

GitHub (👨‍💻 4 · 🔀 5 · 📦 1 · ⏱️ 11.09.2020)
PyPi (📥 87 / month):
```
 pip install mkdocs-mk2pdf-plugin
```
Add to mkdocs.yml:
```
plugins:
  - mk2pdf-export
```

mkdocs-zip-folders - 🥉6 · ⭐ 1 · MIT ·
MkDocs plugin to zip configured folders and add them to the site.

GitHub (⏱️ 09.07.2023)
PyPi (📥 250 / month):
```
 pip install mkdocs-zip-folders
```
Add to mkdocs.yml:
```
plugins:
  - zip_folders
```

helm - 🥉3 · ⭐ 1 · 💤 · Apache-2 ·
An mkdocs plugin that turns docs website into helm repository.

GitHub (🔀 1 · ⏱️ 21.11.2018)
PyPi (📥 30 / month):
```
 pip install mkdocs-helm
```
Add to mkdocs.yml:
```
plugins:
  - helm-repo
```

mkdocs-autozip - 🥉2 · ⭐ 2 · 💤 · ❗Unlicensed ·
A mkdocs plugin for auto zipping the document source.

GitHub (⏱️ 05.10.2022)
PyPi (📥 160 / month):
```
 pip install mkdocs-autozip
```
Add to mkdocs.yml:
```
plugins:
  - autozip
```

🔧 Site building, site management

mike - 🥇28 · ⭐ 480 · 📈 · BSD-3 ·
Manage multiple versions of your MkDocs-powered documentation via Git.

GitHub (👨‍💻 9 · 🔀 43 · 📥 160 · 📦 2.9K · 📋 180 - 4% open · ⏱️ 02.05.2024)
PyPi (📥 250K / month):
```
 pip install mike
```
Add to mkdocs.yml:
```
plugins:
  - mike
```

monorepo - 🥇23 · ⭐ 300 · Apache-2 ·
Build multiple documentation folders in a single Mkdocs. Designed for large codebases.

GitHub (👨‍💻 30 · 🔀 70 · 📦 400 · 📋 61 - 50% open · ⏱️ 04.01.2024)
PyPi (📥 310K / month):
```
 pip install mkdocs-monorepo-plugin
```
Add to mkdocs.yml:
```
plugins:
  - monorepo
```

mkdocs-multirepo-plugin - 🥈21 · ⭐ 110 · MIT ·
Build documentation in multiple repos into one site.

GitHub (👨‍💻 14 · 🔀 40 · 📦 110 · 📋 94 - 47% open · ⏱️ 19.01.2024)
PyPi (📥 44K / month):
```
 pip install mkdocs-multirepo-plugin
```
Add to mkdocs.yml:
```
plugins:
  - multirepo
```

techdocs-core - 🥈21 · ⭐ 76 · Apache-2 ·
The core MkDocs plugin used by Backstages TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown..

GitHub (👨‍💻 38 · 🔀 58 · 📦 50 · 📋 59 - 11% open · ⏱️ 01.04.2024)
PyPi (📥 260K / month):
```
 pip install mkdocs-techdocs-core
```
Add to mkdocs.yml:
```
plugins:
  - techdocs-core
```

simple - 🥈20 · ⭐ 39 · Apache-2 ·
Build documentation files inside your code into a MkDocs site.

GitHub (👨‍💻 8 · 🔀 10 · 📦 46 · ⏱️ 28.04.2024)
PyPi (📥 26K / month):
```
 pip install mkdocs-simple-plugin
```
Add to mkdocs.yml:
```
plugins:
  - simple
```

mkdocs-versioning - 🥈17 · ⭐ 40 · 💤 · MIT ·
A tool that allows for versioning sites built with mkdocs.

GitHub (👨‍💻 5 · 🔀 6 · 📦 69 · 📋 25 - 12% open · ⏱️ 01.08.2021)
PyPi (📥 4.6K / month):
```
 pip install mkdocs-versioning
```
Add to mkdocs.yml:
```
plugins:
  - mkdocs-versioning
```

markdown-docs - 🥈16 · ⭐ 16 · MIT ·
Action/docker image that transforms your markdown into a static website. No need for particular configuration: it just..

GitHub (👨‍💻 4 · 🔀 6 · 📦 42 · ⏱️ 01.05.2024)
Docker Hub (📥 11K · ⏱️ 01.05.2024):
```
 docker pull deloo/markdown-docs
```

Publisher for MkDocs - debugger - 🥈15 · ⭐ 28 · MIT ·
Advanced console and file logger from build and serve process.

GitHub (👨‍💻 2 · 🔀 1 · 📥 9 · 📦 31 · 📋 13 - 30% open · ⏱️ 21.04.2024)
PyPi (📥 2K / month):
```
 pip install mkdocs-publisher
```
Add to mkdocs.yml:
```
plugins:
  - pub-debugger
```

same-dir - 🥉13 · ⭐ 34 · 📉 · MIT ·
MkDocs plugin to allow placing mkdocs.yml in the same directory as documentation.

GitHub (👨‍💻 2 · 🔀 2 · 📦 270 · ⏱️ 03.02.2024)
PyPi (📥 19K / month):
```
 pip install mkdocs-same-dir
```
Add to mkdocs.yml:
```
plugins:
  - same-dir
```

MkDocs Merge - 🥉13 · ⭐ 21 · 💤 · MIT
Merge the source of multiple MkDocs sites into a single one.

GitHub (👨‍💻 3 · 🔀 5 · 📦 4 · 📋 8 - 62% open · ⏱️ 21.01.2023)
PyPi (📥 2.2K / month):
```
 pip install mkdocs-merge
```

multirepo - 🥉12 · ⭐ 34 · MIT
A bit like monorepo, but keeps MkDocs projects separate.

GitHub (👨‍💻 3 · 🔀 2 · ⏱️ 04.01.2024)
PyPi (📥 630 / month):
```
 pip install mkdocs-multirepo
```

mkdocs-exclude-unused-files - 🥉8 · ⭐ 2 · MIT ·
Exclude orphaned (unused) static files from your mkdocs build.

GitHub (👨‍💻 2 · 📦 4 · ⏱️ 27.01.2024)

PyPi (📥 620 / month):

 pip install mkdocs-exclude-unused-files

Add to mkdocs.yml:
```
plugins:
  - exclude-unused-files
```

mkdocs-required-frontmatter-plugin - 🥉8 · 🐣 · MIT ·
This MkDocs plugin enforces required frontmatter for documentation pages.

GitHub (⏱️ 22.03.2024)

PyPi (📥 21 / month):

 pip install mkdocs-required-frontmatter-plugin

Add to mkdocs.yml:
```
plugins:
  - required-frontmatter
```

mkdocs-yamp - 🥉7 · ⭐ 1 · 💤 · Apache-2 ·
Yet Another Multirepo Plugin for MkDocs.

GitHub (👨‍💻 2 · 🔀 2 · 📦 4 · ⏱️ 10.10.2022)
PyPi (📥 110 / month):
```
 pip install mkdocs-yamp
```
Add to mkdocs.yml:
```
plugins:
  - yamp
```

no-sitemap - 🥉7 · 💤 · MIT ·
Disable Mkdocs sitemap generation.

GitHub (📦 7 · ⏱️ 04.04.2023)
PyPi (📥 3.2K / month):
```
 pip install mkdocs-no-sitemap-plugin
```
Add to mkdocs.yml:
```
plugins:
  - no-sitemap
```

progress - 🥉6 · ⭐ 4 · 💤 · Apache-2 ·
A plugin for MkDocs that lets you know exactly what is happening during the build.

GitHub (👨‍💻 3 · 📦 29 · ⏱️ 20.06.2020)
Add to mkdocs.yml:
```
plugins:
  - progress
```

mkdocs-exclude-tagged-files - 🥉5 · ⭐ 3 · MIT ·
A mkdocs plugin for excluding files based on frontmatter tags.

GitHub (👨‍💻 2 · 🔀 2 · 📦 2 · ⏱️ 10.09.2023)

PyPi (📥 95 / month):

 pip install mkdocs-exclude-tagged-files

Add to mkdocs.yml:

plugins:
  - mkdocs_exclude_tagged_files

mkdocs-new-features-notifier - 🥉4 · ⭐ 2 · 💤 · MIT ·
This plugin enables you to notify users of new features in your product. It does this by identifying new documentation..

GitHub (👨‍💻 2 · 🔀 1 · ⏱️ 15.01.2020)

PyPi (📥 760 / month):

 pip install mkdocs-new-features-notifier

Add to mkdocs.yml:

plugins:
  - mkdocs-new-features-notifier

multiple - 🥉3 · ⭐ 1 · 💤 · ❗️GPL-3.0 ·
Allows to merge mkdocs documentations dynamically.

GitHub (👨‍💻 2 · ⏱️ 22.11.2019)
PyPi (📥 590 / month):
```
 pip install mkdocs-multiple
```
Add to mkdocs.yml:
```
plugins:
  - multiple
```

octadocs-adr - 🥉2 · ⭐ 1 · 💤 · ❗Unlicensed ·
A blueprint for Architecture Decision Record in Octadocs - the smart documentation environment.

GitHub (⏱️ 22.08.2021)
PyPi (📥 13 / month):
```
 pip install octadocs-adr
```
Add to mkdocs.yml:
```
plugins:
  - octadocs_adr
```

📁 Snippets & includes (reusing contents)

include-markdown - 🥇24 · ⭐ 88 · Apache-2 ·
Mkdocs Markdown includer plugin.

GitHub (👨‍💻 15 · 🔀 18 · 📥 200 · 📦 2K · 📋 72 - 4% open · ⏱️ 02.05.2024)

PyPi (📥 220K / month):

 pip install mkdocs-include-markdown-plugin

Add to mkdocs.yml:
```
plugins:
  - include-markdown
```

Markdown-Include - 🥈21 · ⭐ 95 · 💤 · ❗️GPL-3.0 ·
Provides syntax for Python-Markdown which allows for the inclusion of the contents of other Markdown documents.

GitHub (👨‍💻 12 · 🔀 36 · 📦 5.8K · 📋 24 - 29% open · ⏱️ 07.02.2023)
PyPi (📥 120K / month):
```
 pip install markdown-include
```

Add to mkdocs.yml:

markdown_extensions:
  - markdown_include.include

meta-descriptions - 🥈20 · ⭐ 15 · MIT ·
Generate meta descriptions from the first paragraphs in your MkDocs pages.

GitHub (👨‍💻 3 · 🔀 3 · 📦 1.1K · 📋 11 - 9% open · ⏱️ 29.04.2024)

PyPi (📥 7K / month):

 pip install mkdocs-meta-descriptions-plugin

Add to mkdocs.yml:
```
plugins:
  - meta-descriptions
```

codeinclude - 🥈15 · ⭐ 14 · 💤 · MIT ·
A plugin to include code snippets into mkdocs pages.

GitHub (👨‍💻 4 · 🔀 5 · 📦 120 · 📋 12 - 41% open · ⏱️ 01.03.2023)
PyPi (📥 7.6K / month):
```
 pip install mkdocs-codeinclude-plugin
```
Add to mkdocs.yml:
```
plugins:
  - codeinclude
```

mkdocs-embed-external-markdown - 🥈15 · ⭐ 7 · MIT ·
MkDocs Embed External Markdown plugin that allow to inject section or all full markdown content from a given url. The..

GitHub (👨‍💻 6 · 🔀 7 · 📦 110 · ⏱️ 26.02.2024)

PyPi (📥 2.9K / month):

 pip install mkdocs-embed-external-markdown

Add to mkdocs.yml:
```
plugins:
  - external-markdown
```

Mdx Include - 🥉11 · ⭐ 50 · 💤 · ❗Unlicensed ·
Python Markdown extension to include local or remote files.

GitHub (👨‍💻 3 · 🔀 3 · 📋 9 - 44% open · ⏱️ 26.07.2022)
PyPi (📥 22K / month):
```
 pip install mdx-include
```
Add to mkdocs.yml:
```
markdown_extensions:
  - mdx_include
```

snippet - 🥉11 · ⭐ 12 · 💤 · MIT ·
An mkdocs plugin that injects snippets from a file in a git repository.

GitHub (👨‍💻 3 · 🔀 3 · 📦 16 · 📋 7 - 42% open · ⏱️ 21.10.2021)
PyPi (📥 1.2K / month):
```
 pip install mkdocs-snippet-plugin
```
Add to mkdocs.yml:
```
plugins:
  - snippet
```

mkdocs-version-annotations - 🥉11 · ⭐ 2 · 💤 · MIT ·
MkDocs plugin to add custom admonitions for documenting version differences.

GitHub (📥 8 · 📦 210 · ⏱️ 14.09.2022)

PyPi (📥 7.1K / month):

 pip install mkdocs-version-annotations

Add to mkdocs.yml:
```
plugins:
  - mkdocs-version-annotations
```

git snippet - 🥉8 · ⭐ 5 · 💤 · MIT ·
Mkdocs plugin that allow to inject snippet or all markdown content from a given remote git repository.

GitHub (👨‍💻 4 · 🔀 3 · 📦 7 · ⏱️ 15.11.2020)
PyPi (📥 730 / month):
```
 pip install mkdocs-gitsnippet-plugin
```
Add to mkdocs.yml:
```
plugins:
  - gitsnippet
```

Related Resources

Best-of lists: 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 and fill in the requested information.
Modify the projects.yaml with your additions or changes, and submit a pull request. This can also be done directly via the Github UI.

If you like to contribute to or share suggestions regarding the project metadata collection or markdown generation, please refer to the best-of-generator repository. If you like to create your own best-of list, we recommend to follow this guide.

For more information on how to add or update projects, please read the contribution guidelines. By participating in this project, you agree to abide by its Code of Conduct.

Name		Name	Last commit message	Last commit date
Latest commit History 281 Commits
.github		.github
config		config
history		history
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
check_projects.py		check_projects.py
latest-changes.md		latest-changes.md
projects.yaml		projects.yaml

License

mkdocs/catalog

Folders and files

Latest commit

History

Repository files navigation

catalog

Contents

Explanation

🎨 Theming

💻 API documentation building

💬 Blogging

📊 Charts, Images, Tables & Graphs

🤖 Code execution, variables & templating

🌲 Git repos & info

🌈 HTML processing & CSS styling

📎 Integrations with other tools

🌍 Internationalization & localization

🔗 Links & references

🧩 Markdown extensions

🧭 Navigation & page building

✅ Quality checks (code blocks, spelling, etc.)

🔍 Search & tables of content

🍱 Site conversion (PDF/ePUB/etc.)

🔧 Site building, site management

📁 Snippets & includes (reusing contents)

Related Resources

Contribution

License

About

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages