Skip to content
forked from mkdocs/catalog

🏆 📚 A list of awesome MkDocs projects and plugins.

License

Notifications You must be signed in to change notification settings

Kutter07/catalog

 
 

Repository files navigation

catalog

🏆 📚 A list of awesome MkDocs projects and plugins.

This list contains 270 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.

Contents

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

Back to top

Material for MkDocs - 🥇42 · ⭐ 19K · MIT · ·
Documentation that simply works.
  • GitHub (👨‍💻 270 · 🔀 3.3K · 📦 51K · 📋 2.4K - 1% open · ⏱️ 24.07.2024)
  • PyPi (📥 5.2M / 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 · 🔀 99 · 📥 990 · 📦 640 · 📋 51 - 31% open · ⏱️ 05.01.2021)
  • PyPi (📥 7.9K / month):
     pip install mkdocs-cinder
    
  • Add to mkdocs.yml:
    theme: cinder
Bootswatch - 🥇19 · ⭐ 140 · BSD-2 ·
MkDocs Bootswatch Themes.
  • GitHub (👨‍💻 10 · 🔀 58 · 📦 1.1K · 📋 33 - 9% open · ⏱️ 29.12.2023)
  • PyPi (📥 20K / 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
Bootstrap - 🥈17 · ⭐ 79 · BSD-2 ·
MkDocs Bootstrap Theme.
  • GitHub (👨‍💻 6 · 🔀 37 · 📦 460 · 📋 16 - 6% open · ⏱️ 29.12.2023)
  • PyPi (📥 23K / month):
     pip install mkdocs-bootstrap
    
  • Add to mkdocs.yml:
    theme: bootstrap
Dracula - 🥈17 · ⭐ 65 · MIT ·
Dark theme for Mkdocs.
  • GitHub (👨‍💻 4 · 🔀 8 · 📦 89 · ⏱️ 17.01.2024)
  • PyPi (📥 1.7K / month):
     pip install mkdocs-dracula-theme
    
  • Add to mkdocs.yml:
    theme: dracula
Torillic - 🥈15 · ⭐ 94 · ❗️CC0-1.0 ·
A D&D inspired theme for styling TTRPG notes and resources.
  • GitHub (👨‍💻 4 · 🔀 91 · 📥 7.1K · ⏱️ 02.06.2024)
  • PyPi (📥 280 / month):
     pip install mkdocs-torillic
    
  • Add to mkdocs.yml:
    theme: torillic
Terminal for MkDocs - 🥈15 · ⭐ 87 · 💤 · MIT ·
monospace theme for MkDocs.
  • GitHub (🔀 1 · 📦 75 · 📋 56 - 44% open · ⏱️ 15.04.2023)
  • PyPi (📥 7.3K / month):
     pip install mkdocs-terminal
    
  • Add to mkdocs.yml:
    theme: terminal
    Extras:
    plugins:
      - md-to-html
Simple Blog - 🥈15 · ⭐ 68 · MIT ·
Blog Template for Mkdocs.
  • GitHub (👨‍💻 3 · 🔀 5 · 📦 65 · 📋 19 - 47% open · ⏱️ 28.01.2024)
  • PyPi (📥 650 / month):
     pip install mkdocs-simple-blog
    
  • Add to mkdocs.yml:
    theme: simple-blog
Windmill - 🥈14 · ⭐ 100 · 💤 · ❗Unlicensed ·
Outstanding mkdocs theme with a focus on navigation and usability.
  • GitHub (👨‍💻 8 · 🔀 47 · 📦 310 · 📋 31 - 48% open · ⏱️ 11.03.2022)
  • PyPi (📥 3.4K / month):
     pip install mkdocs-windmill
    
  • Add to mkdocs.yml:
    theme: windmill
Lantana - 🥈13 · ⭐ 13 · MIT ·
Lantana MKDocsHTML.
  • GitHub (👨‍💻 3 · 📥 260 · 📦 4 · 📋 19 - 5% open · ⏱️ 12.05.2024)
  • PyPi (📥 1.3K / month):
     pip install lantana
    
  • Add to mkdocs.yml:
    theme: lantana
Bootstrap 4 - 🥈12 · ⭐ 7 · MIT ·
A vanilla Bootstrap 4 theme for MkDocs.
  • GitHub (👨‍💻 3 · 📦 7 · 📋 5 - 20% open · ⏱️ 07.06.2024)
  • PyPi (📥 180 / month):
     pip install mkdocs-theme-bootstrap4
    
  • Add to mkdocs.yml:
    theme: bootstrap4
    Extras:
    plugins:
      - bootstrap4-blockquotes
      - bootstrap4-tables
Ivory - 🥉11 · ⭐ 10 · 💤 · MIT ·
Ivory theme for MkDocs.
  • GitHub (👨‍💻 2 · 🔀 4 · 📦 85 · 📋 5 - 40% open · ⏱️ 16.06.2020)
  • PyPi (📥 1.9K / month):
     pip install mkdocs-ivory
    
  • Add to mkdocs.yml:
    theme: ivory
SWAN - 🥉11 · ⭐ 7 · ❗️AGPL-3.0 ·
SWAN MkDocs theme.
  • GitHub (👨‍💻 4 · 🔀 3 · 📦 6 · ⏱️ 23.01.2024)
  • PyPi (📥 240 / month):
     pip install mkdocs-swan
    
  • Add to mkdocs.yml:
    theme: swan
KPN for MkDocs - 🥉10 · ⭐ 8 · MIT ·
KPN theme for MkDocs | owner=flow.
  • GitHub (👨‍💻 3 · 📦 4 · ⏱️ 31.01.2024)
  • PyPi (📥 1.1K / 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 · 📦 19 · ⏱️ 10.03.2022)
  • PyPi (📥 230 / month):
     pip install mkdocs-custommill
    
  • Add to mkdocs.yml:
    theme: custommill
Zettelkasten - 🥉9 · ⭐ 10 · MIT ·
This is a Zettelkasten theme and plugin for MkDocs. It renders the MkDocs pages as cards (zettels).
  • GitHub (👨‍💻 3 · 🔀 1 · 📥 19 · 📦 4 · 📋 10 - 70% open · ⏱️ 07.07.2024)
  • PyPi (📥 86 / month):
     pip install mkdocs-zettelkasten
    
  • Add to mkdocs.yml:
    theme: zettelkasten-solarized-light
    Extras:
    plugins:
      - zettelkasten
Alabaster - 🥉8 · ⭐ 36 · 💤 · ❗Unlicensed ·
Alabaster port for MkDocs.
  • GitHub (👨‍💻 9 · 🔀 10 · 📋 17 - 17% open · ⏱️ 16.06.2020)
  • PyPi (📥 700 / 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 (📥 460 / month):
     pip install mkdocs-windmill-dark
    
  • Add to mkdocs.yml:
    theme: windmill-dark
GitBook - 🥉8 · ⭐ 28 · 💤 · ❗Unlicensed ·
Default theme for GitBook for Mkdocs https://lramage.gitlab.io/mkdocs-gitbook-theme.
  • PyPi (📥 18K / month):
     pip install mkdocs-gitbook
    
  • GitLab (🔀 13 · 📋 19 - 47% open · ⏱️ 17.12.2018)
  • Add to mkdocs.yml:
    theme: gitbook
BOOTSTRAP386 - 🥉7 · ⭐ 32 · 💤 · ❗Unlicensed ·
A vintage 1980s DOS inspired Twitter Bootstrap theme for MkDocs https://lramage.gitlab.io/mkdocs-bootstrap386.
  • PyPi (📥 6K / month):
     pip install mkdocs-bootstrap386
    
  • GitLab (🔀 3 · 📋 7 - 57% open · ⏱️ 06.06.2018)
  • Add to mkdocs.yml:
    theme: bootstrap386
Nature - 🥉7 · ⭐ 5 · ❗Unlicensed ·
A MkDocs theme.
  • GitHub (👨‍💻 2 · 🔀 1 · 📦 43 · ⏱️ 14.09.2023)
  • PyPi (📥 1K / month):
     pip install mkdocs-nature
    
  • Add to mkdocs.yml:
    theme: nature
Risonia - 🥉7 · ⭐ 3 · ❗Unlicensed ·
A simple theme for MkDocs, using the w3.css framework and configurable color schemes.
  • GitHub (🔀 1 · 📦 3 · ⏱️ 01.09.2023)
  • PyPi (📥 100 / month):
     pip install mkdocs-risonia-theme
    
  • Add to mkdocs.yml:
    theme: risonia
    Extras:
    plugins:
      - color-theme
      - w3css-classes
docSkimmer - 🥉6 · ⭐ 18 · ❗Unlicensed ·
An accessible, skimmable theme for MkDocs.
mkdocs-theme-topdf - 🥉6 · ⭐ 10 · 💤 · MPL-2.0 ·
A mkdocs theme for create PDF and printing with paged.js.
  • GitHub (🔀 1 · 📦 3 · ⏱️ 26.06.2021)
  • PyPi (📥 56 / month):
     pip install mkdocs-theme-topdf
    
  • Add to mkdocs.yml:
    theme: topdf
Moonstone - 🥉6 · ⭐ 6 · 💤 · ❗Unlicensed ·
A documentation theme for mkdocs.
  • GitHub (🔀 1 · 📦 9 · ⏱️ 15.06.2021)
  • PyPi (📥 760 / month):
     pip install mkdocs-moonstone
    
  • Add to mkdocs.yml:
    theme: moonstone
GitHub - 🥉5 · ⭐ 2 · 💤 · MIT ·
Theme Mkdocs Like a Github. DEMO =.
  • GitHub (📦 9 · ⏱️ 25.02.2020)
  • PyPi (📥 130 / 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 (📥 360 / month):
     pip install mkdocs-cluster
    
  • GitLab (🔀 1 · ⏱️ 02.06.2016)
  • Add to mkdocs.yml:
    theme: cluster

💻 API documentation building

Back to top

mkdocstrings - 🥇32 · ⭐ 1.6K · ISC ·
Automatic documentation from sources, for MkDocs.
  • GitHub (👨‍💻 42 · 🔀 100 · 📦 14K · 📋 400 - 12% open · ⏱️ 25.07.2024)
  • PyPi (📥 1.2M / month):
     pip install mkdocstrings
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocstrings
mkdocstrings-python - 🥇23 · ⭐ 160 · ISC
A Python handler for mkdocstrings.
  • GitHub (👨‍💻 18 · 🔀 31 · 📋 120 - 22% open · ⏱️ 25.07.2024)
  • PyPi (📥 1.7M / month):
     pip install mkdocstrings-python
    
mkdoxy - 🥈21 · ⭐ 64 · MIT ·
Automatically generates API documentation for your project based on Doxygen comments and code snippets in your..
  • GitHub (👨‍💻 12 · 🔀 16 · 📦 16 · 📋 53 - 16% open · ⏱️ 18.06.2024)
  • PyPi (📥 32K / month):
     pip install mkdoxy
    
  • Add to mkdocs.yml:
    plugins:
      - mkdoxy
MkDocsOAD - 🥈19 · ⭐ 120 · MIT · ·
Plugin for MkDocs to generate human readable documentation from OpenAPI Documentation Version 3 (also known as Swagger..
  • GitHub (👨‍💻 10 · 🔀 9 · 📥 1.1K · 📦 220 · 📋 37 - 43% open · ⏱️ 01.02.2024)
  • PyPi (📥 39K / 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 · ⭐ 110 · Apache-2 ·
An MkDocs extension to generate documentation for Click command line applications.
  • GitHub (👨‍💻 13 · 🔀 15 · 📦 510 · 📋 30 - 50% open · ⏱️ 11.02.2024)
  • PyPi (📥 41K / month):
     pip install mkdocs-click
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mkdocs-click
MkApi - 🥈18 · ⭐ 95 · MIT ·
A plugin for MkDocs to generate API documentation.
  • GitHub (👨‍💻 5 · 🔀 17 · 📦 190 · 📋 89 - 24% open · ⏱️ 03.04.2024)
  • PyPi (📥 3.6K / month):
     pip install mkapi
    
  • Add to mkdocs.yml:
    plugins:
      - mkapi
mkdocstrings-crystal - 🥈18 · ⭐ 28 · MIT
Crystal language doc generator for https://github.com/mkdocstrings/mkdocstrings.
  • GitHub (👨‍💻 3 · 🔀 3 · 📦 650 · 📋 4 - 75% open · ⏱️ 03.02.2024)
  • PyPi (📥 12K / month):
     pip install mkdocstrings-crystal
    
MkAutoDoc - 🥉16 · ⭐ 210 · 💤 · ❗️BSD ·
Auto documentation for MkDocs.
  • GitHub (👨‍💻 7 · 🔀 15 · 📦 810 · 📋 18 - 38% open · ⏱️ 26.09.2022)
  • PyPi (📥 15K / month):
     pip install mkautodoc
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mkautodoc
mktheapidocs - 🥉12 · ⭐ 12 · 💤 · MIT ·
Numpydocs - mkdocs friendly markdown.
  • GitHub (👨‍💻 6 · 🔀 3 · 📦 42 · 📋 16 - 62% open · ⏱️ 10.06.2022)
  • PyPi (📥 510 / month):
     pip install mktheapidocs
    
  • Add to mkdocs.yml:
    plugins:
      - mktheapidocs
mkdocs-typer - 🥉11 · ⭐ 28 · 💤 · Apache-2 ·
An MkDocs extension to generate documentation for Typer command line applications.
  • GitHub (🔀 2 · 📋 7 - 57% open · ⏱️ 21.06.2023)
  • PyPi (📥 7.9K / month):
     pip install mkdocs-typer
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mkdocs-typer
mkdocstrings-vba - 🥉9 · ⭐ 3 · ISC
VBA handler for mkdocstrings.
  • GitHub (👨‍💻 3 · 🔀 1 · 📦 2 · 📋 8 - 25% open · ⏱️ 20.04.2024)
  • PyPi (📥 39 / month):
     pip install mkdocstrings-vba
    
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 · ⭐ 6 · MIT ·
The MkDocs-Typedoc Plugin is a MkDocs plugin that allows you to include TypeDoc documentation in your MkDocs site.
  • GitHub (👨‍💻 2 · 🔀 1 · ⏱️ 03.05.2024)
  • PyPi (📥 1K / 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
inari - 🥉6 · ⭐ 5 · 💤 · MIT ·
Write docstrings in markdown!.
  • GitHub (📦 7 · 📋 2 - 50% open · ⏱️ 10.07.2021)
  • PyPi (📥 120 / month):
     pip install inari
    
  • Add to mkdocs.yml:
    plugins:
      - inari
mkdocstrings-shell - 🥉6 · ISC
A shell scripts/libraries handler for mkdocstrings. Only available to sponsors.
  • GitHub (📦 2 · ⏱️ 25.05.2024)
mkdocs-yaarg-plugin - 🥉2 · ⭐ 2 · 💤 · ❗Unlicensed ·
Yet Another API Reference Generator plugin for MKDocs.
  • GitHub (📦 1 · ⏱️ 14.03.2021)
  • PyPi (📥 30 / month):
     pip install mkdocs-yaarg-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - yaarg
ansible-document - 🥉2 · ❗Unlicensed
Auto-generate ansible role documentation.
  • PyPi (📥 53 / month):
     pip install ansible-mkdocs
    

💬 Blogging

Back to top

rss - 🥇25 · ⭐ 73 · MIT ·
MkDocs plugin to generate a RSS feeds for created and updated pages, using git log and YAML frontmatter (page.meta).
  • GitHub (👨‍💻 16 · 🔀 26 · 📥 78 · 📦 610 · 📋 49 - 26% open · ⏱️ 22.07.2024)
  • PyPi (📥 44K / month):
     pip install mkdocs-rss-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - rss
mkdocs-blogging-plugin - 🥈17 · ⭐ 84 · MIT ·
Add blogging feature to your MkDocs site.
  • GitHub (👨‍💻 7 · 🔀 16 · 📥 14 · 📦 190 · 📋 41 - 12% open · ⏱️ 21.07.2023)
  • PyPi (📥 6.1K / month):
     pip install mkdocs-blogging-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - blogging
Publisher for MkDocs - blog - 🥈16 · ⭐ 44 · MIT ·
Blogging engine with support for categories, tags and archive.
  • GitHub (👨‍💻 2 · 🔀 1 · 📥 32 · 📦 57 · 📋 17 - 41% open · ⏱️ 20.07.2024)
  • PyPi (📥 1.4K / month):
     pip install mkdocs-publisher
    
  • Add to mkdocs.yml:
    plugins:
      - pub-blog
newsletter - 🥉13 · ⭐ 29 · ❗️GPL-3.0 ·
Automatically create newsletters from the changes in a mkdocs repository.
  • GitHub (👨‍💻 3 · 🔀 2 · 📦 45 · 📋 10 - 30% open · ⏱️ 27.05.2024)
  • PyPi (📥 850 / month):
     pip install mkdocs-newsletter
    
  • Add to mkdocs.yml:
    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 (🔀 4 · 📦 110 · 📋 2 - 50% open · ⏱️ 13.04.2020)
  • PyPi (📥 2.1K / 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 (📥 130 / month):
     pip install mkblog
    
  • Add to mkdocs.yml:
    plugins:
      - mkblog

📊 Charts, Images, Tables & Graphs

Back to top

plantuml-markdown - 🥇27 · ⭐ 190 · 📉 · BSD-2 ·
PlantUML plugin for Python-Markdown.
  • GitHub (👨‍💻 29 · 🔀 54 · 📦 1.4K · 📋 66 - 3% open · ⏱️ 13.07.2024)
  • PyPi (📥 350K / month):
     pip install plantuml-markdown
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - plantuml_markdown
MkDocs GLightbox - 🥇23 · ⭐ 120 · MIT ·
A MkDocs plugin supports image lightbox (zoom effect) with GLightbox.
  • GitHub (👨‍💻 6 · 🔀 14 · 📥 29 · 📦 2.9K · 📋 39 - 33% open · ⏱️ 23.05.2024)
  • PyPi (📥 240K / month):
     pip install mkdocs-glightbox
    
  • Add to mkdocs.yml:
    plugins:
      - glightbox
mermaid2 - 🥇22 · ⭐ 200 · MIT ·
A Mermaid graphs plugin for mkdocs.
  • GitHub (👨‍💻 15 · 🔀 25 · 📦 2.1K · 📋 67 - 8% open · ⏱️ 03.06.2024)
  • PyPi (📥 220K / month):
     pip install mkdocs-mermaid2-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - mermaid2
kroki - 🥇22 · ⭐ 42 · MIT ·
MkDocs plugin for Kroki-Diagrams.
  • GitHub (👨‍💻 15 · 🔀 25 · 📦 41 · 📋 33 - 15% open · ⏱️ 21.06.2024)
  • PyPi (📥 44K / month):
     pip install mkdocs-kroki-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - kroki
table-reader - 🥈21 · ⭐ 110 · MIT ·
MkDocs plugin that enables a markdown tag like {{ read_csv(table.csv) }} to directly insert various table formats into..
  • GitHub (👨‍💻 8 · 🔀 18 · 📦 730 · 📋 46 - 10% open · ⏱️ 20.05.2024)
  • PyPi (📥 57K / month):
     pip install mkdocs-table-reader-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - table-reader
drawio-exporter - 🥈20 · ⭐ 77 · 📉 · MIT ·
Exports your Draw.io diagrams at build time for easier embedding into your documentation.
  • GitHub (👨‍💻 5 · 🔀 7 · 📦 76 · 📋 28 - 14% open · ⏱️ 10.07.2024)
  • PyPi (📥 11K / month):
     pip install mkdocs-drawio-exporter
    
  • Add to mkdocs.yml:
    plugins:
      - drawio-exporter
build-plantuml - 🥈17 · ⭐ 58 · MIT ·
MkDocs plugin to help generate your plantuml images locally or remotely as files (NOT inline).
  • GitHub (👨‍💻 11 · 🔀 16 · 📦 110 · 📋 23 - 8% open · ⏱️ 25.03.2024)
  • PyPi (📥 47K / month):
     pip install mkdocs-build-plantuml-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - build_plantuml
Markdown blockdiag - 🥈17 · ⭐ 26 · MIT ·
blockdiag extension for Python Markdown.
  • GitHub (👨‍💻 5 · 🔀 9 · 📦 110 · 📋 6 - 50% open · ⏱️ 22.11.2023)
  • PyPi (📥 3.1K / month):
     pip install markdown-blockdiag
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - markdown_blockdiag
charts - 🥈16 · ⭐ 76 · MIT ·
Mkdocs plugin to add vegalite charts to your pages.
  • GitHub (👨‍💻 3 · 🔀 6 · 📦 66 · 📋 19 - 15% open · ⏱️ 25.09.2023)
  • PyPi (📥 7.2K / month):
     pip install mkdocs-charts-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - charts
MkDocs Video - 🥈16 · ⭐ 65 · MIT ·
MkDocs Video plugin.
  • GitHub (👨‍💻 5 · 🔀 13 · 📥 50 · 📦 710 · ⏱️ 04.01.2024)
  • PyPi (📥 52K / month):
     pip install mkdocs-video
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-video
Lightgallery - 🥈14 · ⭐ 26 · MIT ·
Markdown extension to wrap images in a lightbox.
  • GitHub (👨‍💻 6 · 🔀 4 · 📦 94 · 📋 11 - 54% open · ⏱️ 07.10.2023)
  • PyPi (📥 3.7K / month):
     pip install lightgallery
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - lightgallery
mkdocs-diagrams - 🥈13 · ⭐ 26 · 💤 · MIT ·
MkDocs plugin to render Diagrams files.
  • GitHub (🔀 3 · 📦 62 · 📋 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 · 📦 90 · 📋 6 - 33% open · ⏱️ 26.05.2019)
  • PyPi (📥 6.2K / month):
     pip install mkdocs-mermaid-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - markdownmermaid
mkdocs-d2-plugin - 🥈11 · ⭐ 17 · MIT ·
A plugin for embedding D2 diagrams in MkDocs.
  • GitHub (👨‍💻 3 · 🔀 3 · 📦 7 · 📋 9 - 22% open · ⏱️ 22.05.2024)
  • PyPi (📥 3.6K / month):
     pip install mkdocs-d2-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - d2
docutools - 🥉10 · ⭐ 23 · BSD-2 ·
Dev Centric Tools for Mkdocs Based Documentation.
  • GitHub (👨‍💻 3 · 📦 7 · 📋 2 - 50% open · ⏱️ 04.09.2023)
  • PyPi (📥 240 / 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
MkDocs Img2Fig Plugin - 🥉10 · ⭐ 20 · 💤 · MIT ·
A MkDocs plugin that converts markdown encoded images into figure elements.
  • GitHub (👨‍💻 2 · 🔀 7 · 📦 120 · 📋 3 - 66% open · ⏱️ 14.07.2020)
  • PyPi (📥 2K / 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 · 📦 150 · 📋 8 - 25% open · ⏱️ 24.05.2023)
  • PyPi (📥 1.7K / month):
     pip install markdown-captions
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - markdown_captions
Termage - 🥉9 · ⭐ 21 · 💤 · MIT ·
Generate SVGs from any Python code, even in your documentation.
  • GitHub (📦 2 · 📋 5 - 20% open · ⏱️ 23.08.2022)
  • PyPi (📥 26 / month):
     pip install Termage
    
  • Add to mkdocs.yml:
    plugins:
      - termage
badges - 🥉9 · ⭐ 9 · MIT ·
Add badges to your mkdocs page.
  • GitHub (🔀 1 · ⏱️ 22.06.2024)
  • PyPi (📥 2.3K / month):
     pip install mkdocs-badges
    
  • Add to mkdocs.yml:
    plugins:
      - badges
Interactive Graph - 🥉9 · ⭐ 9 · 🐣 · MIT ·
interactive graph for Material for MkDocs like Obsidian, refer demo:.
  • GitHub (👨‍💻 2 · 📦 4 · ⏱️ 24.04.2024)
  • PyPi (📥 2.7K / month):
     pip install mkdocs-obsidian-interactive-graph-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - obsidian-interactive-graph
markdownwavedrom - 🥉8 · ⭐ 9 · 💤 · MPL-2.0 ·
A MkDocs plugin for support wavedrom charts in markdown file.
  • GitHub (🔀 2 · 📦 13 · 📋 3 - 33% open · ⏱️ 26.06.2021)
  • PyPi (📥 150 / month):
     pip install mkdocs-wavedrom-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - markdownwavedrom
svgbob extension for Python Markdown - 🥉8 · ⭐ 6 · MIT ·
svgbob extension for Python Markdown.
  • GitHub (👨‍💻 2 · 🔀 2 · 📦 9 · ⏱️ 21.06.2024)
  • PyPi (📥 450 / month):
     pip install markdown-svgbob
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - markdown_svgbob
plotly charts - 🥉7 · ⭐ 9 · MIT ·
Mkdocs plugin to add interactive charts with Plotly.js.
  • GitHub (👨‍💻 3 · ⏱️ 25.07.2023)
  • PyPi (📥 3K / month):
     pip install mkdocs-plotly-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - plotly
mkdocs-resize-images - 🥉7 · ⭐ 2 · MIT ·
MkDocs plugin to resize images according to the configuration.
  • GitHub (📦 7 · ⏱️ 04.11.2023)
  • PyPi (📥 1K / month):
     pip install mkdocs-resize-images
    
  • Add to mkdocs.yml:
    plugins:
      - resize-images
MkDocs Graphviz - 🥉6 · ⭐ 5 · 💤 · ❗Unlicensed ·
A mkdocs Extension that automatically renders Graphviz images, in SVG or PNG format, within your markdown file.
  • PyPi (📥 2.6K / month):
     pip install mkdocs-graphviz
    
  • GitLab (🔀 1 · 📋 7 - 42% open · ⏱️ 03.05.2021)
  • Add to mkdocs.yml:
    markdown_extensions:
      - mkdocs_graphviz
Markdown aafigure - 🥉5 · ⭐ 4 · MIT ·
aafigure extension for Python Markdown.
  • GitHub (👨‍💻 2 · 🔀 1 · 📋 3 - 33% open · ⏱️ 04.05.2024)
  • PyPi (📥 130 / month):
     pip install markdown-aafigure
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - markdown_aafigure
thumbnails - 🥉5 · ⭐ 2 · 💤 · MIT ·
MkDocs plugin for thumbnail images generated automatically.
  • GitHub (📋 2 - 50% open · ⏱️ 05.06.2023)
  • PyPi (📥 340 / 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 (📦 6 · ⏱️ 09.03.2019)
  • PyPi (📥 110 / 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 (📦 2 · ⏱️ 17.03.2019)
  • PyPi (📥 27 / 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)
inline-svg - 🥉4 · MIT ·
  • GitHub (👨‍💻 5 · 🔀 1 · 📦 4 · ⏱️ 12.01.2024)
  • PyPi (📥 100 / month):
     pip install mkdocs-plugin-inline-svg-mod
    
  • Add to mkdocs.yml:
    plugins:
      - inline-svg
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
image-formatter-plugin - 🥉3 · ⭐ 4 · ❗Unlicensed ·
  • GitHub (👨‍💻 7 · 📦 1 · ⏱️ 06.12.2023)
  • PyPi (📥 25 / month):
     pip install mkdocs-image-formatter-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - image-formatter
import-statement - 🥉3 · ⭐ 2 · 💤 · MIT ·
  • GitHub (📦 2 · ⏱️ 06.02.2023)
  • PyPi (📥 85 / month):
     pip install mkdocs-import-statement-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - import-statement
MkHack3rs - 🥉2 · ⭐ 4 · 💤 · ❗Unlicensed ·
Hacks & Integrations for Mkdocs / Material Theme.
  • GitLab (🔀 1 · ⏱️ 01.05.2021)

🤖 Code execution, variables & templating

Back to top

macros - 🥇26 · ⭐ 310 · MIT ·
Create richer and more beautiful pages in MkDocs, by using variables and calls to macros in the markdown code.
  • GitHub (👨‍💻 33 · 🔀 48 · 📦 3.5K · 📋 120 - 1% open · ⏱️ 02.06.2024)
  • PyPi (📥 420K / month):
     pip install mkdocs-macros-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - macros
mkdocs-jupyter - 🥇24 · ⭐ 370 · Apache-2 ·
Use Jupyter Notebook in mkdocs.
  • GitHub (👨‍💻 28 · 🔀 45 · 📦 2.6K · 📋 120 - 19% open · ⏱️ 20.07.2024)
  • PyPi (📥 130K / month):
     pip install mkdocs-jupyter
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-jupyter
markdown-exec - 🥈22 · ⭐ 93 · ISC ·
Utilities to execute code blocks in Markdown files.
  • GitHub (👨‍💻 2 · 🔀 7 · 📦 280 · 📋 50 - 20% open · ⏱️ 08.07.2024)
  • PyPi (📥 37K / month):
     pip install markdown-exec
    
  • Add to mkdocs.yml:
    plugins:
      - markdown-exec
mknotebooks - 🥈20 · ⭐ 130 · MIT ·
A plugin for mkdocs to help you include Jupyter notebooks in your projects.
  • GitHub (👨‍💻 14 · 🔀 19 · 📦 560 · 📋 40 - 35% open · ⏱️ 11.08.2023)
  • PyPi (📥 22K / month):
     pip install mknotebooks
    
  • Add to mkdocs.yml:
    plugins:
      - mknotebooks
gen-files - 🥈20 · ⭐ 98 · MIT ·
MkDocs plugin to programmatically generate documentation pages during the build.
  • GitHub (👨‍💻 5 · 🔀 8 · 📦 2.2K · 📋 25 - 28% open · ⏱️ 27.04.2024)
  • PyPi (📥 310K / month):
     pip install mkdocs-gen-files
    
  • Add to mkdocs.yml:
    plugins:
      - gen-files
markdownextradata - 🥈20 · ⭐ 79 · 💤 · MIT ·
A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template.
  • GitHub (👨‍💻 10 · 🔀 17 · 📦 1.2K · 📋 34 - 23% open · ⏱️ 15.12.2021)
  • PyPi (📥 39K / month):
     pip install mkdocs-markdownextradata-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - markdownextradata
mkdocs-markmap - 🥈15 · ⭐ 44 · MIT ·
MkDocs plugin and extension to create mindmaps from markdown using markmap.
  • GitHub (👨‍💻 3 · 🔀 5 · 📥 230 · 📋 26 - 7% open · ⏱️ 05.10.2023)
  • PyPi (📥 1.8K / month):
     pip install mkdocs-markmap
    
  • Add to mkdocs.yml:
    plugins:
      - markmap
Termynal - 🥈14 · ⭐ 87 · MIT ·
Python markdown terminal. Built for mkdocs.
  • GitHub (👨‍💻 5 · 🔀 8 · 📦 200 · 📋 16 - 50% open · ⏱️ 01.06.2024)
  • PyPi (📥 5.3K / 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 · 📦 48 · ⏱️ 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 · 📦 14 · ⏱️ 10.07.2022)
  • PyPi (📥 1.1K / month):
     pip install mkdocs-user-defined-values
    
  • Add to mkdocs.yml:
    plugins:
      - user-defined-values
placeholder - 🥉11 · ⭐ 11 · 📉 · MIT ·
Add placeholders to your MkDocs pages.
  • GitHub (👨‍💻 2 · 🔀 3 · ⏱️ 13.07.2024)
  • PyPi (📥 1.2K / month):
     pip install mkdocs-placeholder-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - placeholder
nbconvert - 🥉9 · ⭐ 9 · BSD-2 ·
A MkDocs plug-in provides a source parser for *.ipynb files.
  • GitHub (👨‍💻 5 · 🔀 1 · 📦 3 · ⏱️ 09.04.2024)
  • PyPi (📥 580 / 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 · 📦 23 · ⏱️ 06.02.2019)
  • PyPi (📥 460 / 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 · 📦 6 · 📋 3 - 33% open · ⏱️ 09.05.2024)
  • PyPi (📥 960 / 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 (📦 1 · ⏱️ 07.06.2023)
  • PyPi (📥 96 / month):
     pip install mkjsfiddle
    
  • Add to mkdocs.yml:
    plugins:
      - jsfiddle
Entangled - 🥉6 · ⭐ 1 · Apache-2 ·
An MkDocs plugin that lets you do Literate Programming through Entangled.
  • GitHub (📦 8 · ⏱️ 14.10.2023)
  • PyPi (📥 75 / month):
     pip install mkdocs-entangled-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - entangled
jinja2sandbox - 🥉5 · ⭐ 4 · 💤 · MIT ·
A MkDocs plugin that enables the Jinja2-sandbox.
codeyaml - 🥉5 · 💤 · MIT ·
Allows for more than one yaml config in mkdocs.
  • GitHub (🔀 1 · 📦 1 · ⏱️ 30.04.2019)
  • PyPi (📥 27 / 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 (📥 380 / month):
     pip install mkdocs-protobuf
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs_protobuf

🌲 Git repos & info

Back to top

git-revision-date-localized - 🥇29 · ⭐ 180 · MIT ·
MkDocs plugin to add a last updated date to your site pages.
  • GitHub (👨‍💻 25 · 🔀 35 · 📦 7.1K · 📋 90 - 13% open · ⏱️ 30.06.2024)
  • PyPi (📥 520K / month):
     pip install mkdocs-git-revision-date-localized-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - git-revision-date-localized
git-authors - 🥈23 · ⭐ 71 · MIT ·
MkDocs plugin to display git authors of a page.
  • GitHub (👨‍💻 12 · 🔀 16 · 📦 890 · 📋 57 - 17% open · ⏱️ 08.05.2024)
  • PyPi (📥 93K / month):
     pip install mkdocs-git-authors-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - git-authors
git-committers-2 - 🥈21 · ⭐ 49 · MIT ·
An MkDocs plugin to create a list of contributors on the page.
  • GitHub (👨‍💻 13 · 🔀 16 · 📦 610 · 📋 37 - 29% open · ⏱️ 11.07.2024)
  • PyPi (📥 31K / 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 · 🔀 7 · 📦 2.3K · 📋 14 - 35% open · ⏱️ 08.03.2022)
  • PyPi (📥 110K / month):
     pip install mkdocs-git-revision-date-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - git-revision-date
git-committers - 🥉16 · ⭐ 39 · MIT ·
A mkdocs plugin for displaying the last commit and a list of a files contributors.
  • GitHub (👨‍💻 6 · 🔀 7 · 📦 200 · ⏱️ 06.11.2023)
  • PyPi (📥 28K / month):
     pip install mkdocs-git-committers-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - git-committers
mkdocs-git-latest-changes-plugin - 🥉10 · ⭐ 1 · MIT ·
MkDocs plugin that allows you to display a list of recently modified pages from the Git log.
  • GitHub (👨‍💻 2 · 🔀 2 · 📦 4 · 📋 13 - 23% open · ⏱️ 02.06.2024)
  • PyPi (📥 390 / month):
     pip install mkdocs-git-latest-changes-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - git-latest-changes
Github-Links - 🥉8 · ⭐ 10 · ❗Unlicensed ·
Python-Markdown GitHub Links Extension.
  • GitHub (👨‍💻 4 · 🔀 9 · ⏱️ 22.12.2023)
  • PyPi (📥 6.9K / month):
     pip install mdx-gh-links
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mdx_gh_links
branchcustomization - 🥉7 · ⭐ 2 · 💤 · MIT ·
Customize MkDocs options on a per-branch basis.
  • GitHub (📦 16 · ⏱️ 17.04.2022)
  • PyPi (📥 360 / month):
     pip install mkdocs-branchcustomization-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - branchcustomization
Github Releaase Changelog - 🥉5 · ⭐ 4 · MIT ·
mkdocs extension to autogenerate changelog from github releases.
  • GitHub (👨‍💻 2 · ⏱️ 02.01.2024)
  • PyPi (📥 49 / month):
     pip install mkdocs-github-changelog
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs_github_changelog
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 (📥 870 / month):
     pip install mkdocs-latest-release-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - git-latest-release

🌈 HTML processing & CSS styling

Back to top

minify - 🥇21 · ⭐ 140 · MIT ·
A mkdocs plugin to minify the HTML of a page before it is written to disk.
  • GitHub (👨‍💻 14 · 🔀 17 · 📦 7.9K · 📋 17 - 23% open · ⏱️ 29.01.2024)
  • PyPi (📥 200K / month):
     pip install mkdocs-minify-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - minify
enumerate-headings - 🥇21 · ⭐ 38 · MIT ·
MkDocs Plugin to enumerate the headings across site pages.
  • GitHub (👨‍💻 5 · 🔀 8 · 📦 210 · 📋 31 - 9% open · ⏱️ 16.04.2024)
  • PyPi (📥 19K / month):
     pip install mkdocs-enumerate-headings-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - enumerate-headings
minify-html - 🥈17 · ⭐ 6 · MIT ·
MkDocs plugin for minification using minify-html, an extremely fast and smart HTML + JS + CSS minifier.
  • GitHub (👨‍💻 3 · 📦 17 · ⏱️ 22.07.2024)
  • PyPi (📥 6.5K / month):
     pip install mkdocs-minify-html-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - minify_html
Publisher for MkDocs - social - 🥈16 · ⭐ 44 · MIT ·
Social media sharing helper.
  • GitHub (👨‍💻 2 · 🔀 1 · 📥 32 · 📦 57 · 📋 17 - 41% open · ⏱️ 20.07.2024)
  • PyPi (📥 1.4K / month):
     pip install mkdocs-publisher
    
  • Add to mkdocs.yml:
    plugins:
      - pub-social
Publisher for MkDocs - minifier - 🥈16 · ⭐ 44 · MIT ·
Size optimization (minification) for HTML, CSS, JS, SVG, PNG and JPEG files.
  • GitHub (👨‍💻 2 · 🔀 1 · 📥 32 · 📦 57 · 📋 17 - 41% open · ⏱️ 20.07.2024)
  • PyPi (📥 1.4K / month):
     pip install mkdocs-publisher
    
  • Add to mkdocs.yml:
    plugins:
      - pub-minifier
mkdocs_safe_text - 🥈13 · ⭐ 3 · BSD-2 ·
Plugin for safe text editing with MKDocs.
  • GitHub (👨‍💻 2 · 📦 8 · ⏱️ 22.07.2024)
  • PyPi (📥 940 / month):
     pip install mkdocs-safe-text-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs_safe_text
mkdocs-link-embeds - 🥉12 · ⭐ 4 · 🐣 · MIT ·
Mkdocs plugin which displays links in a more elegant way. Links will automatically be populated with an image,..
  • GitHub (📥 1 · 📦 4 · ⏱️ 15.07.2024)
  • PyPi (📥 470 / month):
     pip install mkdocs-link-embeds-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - link-embeds
add-number - 🥉11 · ⭐ 16 · 💤 · MIT ·
MkDocs plugin to automatically number the headings (h1-h6) in each markdown page and the nav.
  • GitHub (👨‍💻 3 · 🔀 3 · 📦 38 · 📋 11 - 18% open · ⏱️ 11.06.2020)
  • PyPi (📥 7.4K / month):
     pip install mkdocs-add-number-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - add-number
mkdocs-extra-sass-plugin - 🥉10 · ⭐ 3 · 💤 · MIT ·
Adds stylesheets to your mkdocs site from Sass/SCSS.
  • GitHub (🔀 2 · 📦 39 · ⏱️ 13.02.2021)
  • PyPi (📥 5.1K / month):
     pip install mkdocs-extra-sass-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - extra-sass
bootstrap-tables - 🥉9 · ⭐ 12 · 💤 · MIT ·
A MkDocs plugin to add bootstrap classes to plan markdown generated tables.
  • GitHub (🔀 2 · 📦 76 · ⏱️ 27.03.2020)
  • PyPi (📥 1.7K / month):
     pip install mkdocs-bootstrap-tables-plugin
    
  • Add to mkdocs.yml:
    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 (👨‍💻 3 · 🔀 1 · 📦 3 · ⏱️ 08.11.2022)
  • PyPi (📥 560 / month):
     pip install mkdocs-add-teaser
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-add-teaser
MkDocs Pygments - 🥉6 · ⭐ 5 · 🐣 · ISC ·
Highlighting themes for code blocks. Available to sponsors only.
  • GitHub (🔀 1 · 📦 1 · ⏱️ 24.05.2024)
  • Add to mkdocs.yml:
    plugins:
      - pygments
toggle-sidebar - 🥉6 · ⭐ 3 · MIT ·
Toggle the navigation and/or TOC sidebars on your MkDocs site.
  • GitHub (⏱️ 23.09.2023)
  • PyPi (📥 380 / 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.

📎 Integrations with other tools

Back to top

MkDocs Swagger UI Tag - 🥇18 · ⭐ 73 · MIT ·
A MkDocs plugin supports adding Swagger UI to the page.
  • GitHub (👨‍💻 3 · 🔀 7 · 📥 35 · 📦 170 · 📋 22 - 22% open · ⏱️ 01.05.2024)
  • PyPi (📥 41K / month):
     pip install mkdocs-swagger-ui-tag
    
  • Add to mkdocs.yml:
    plugins:
      - swagger-ui-tag
mkdocs-coverage - 🥇18 · ⭐ 19 · ISC ·
MkDocs plugin to integrate your coverage HTML report into your site.
  • GitHub (🔀 1 · 📦 210 · 📋 10 - 50% open · ⏱️ 11.06.2024)
  • PyPi (📥 19K / month):
     pip install mkdocs-coverage
    
  • Add to mkdocs.yml:
    plugins:
      - coverage
mkdocs-render-swagger-plugin - 🥈16 · ⭐ 69 · MIT ·
A plugin for MKDocs for rendering swagger & openapi schemas using SwaggerUI.
  • GitHub (👨‍💻 8 · 🔀 12 · 📥 4 · 📋 15 - 20% open · ⏱️ 26.05.2024)
  • PyPi (📥 56K / month):
     pip install mkdocs-render-swagger-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - render_swagger
Publisher for MkDocs - obsidian - 🥈16 · ⭐ 44 · MIT ·
Obsidian.md integration including with support for wiki links, callouts, backlinks etc.
  • GitHub (👨‍💻 2 · 🔀 1 · 📥 32 · 📦 57 · 📋 17 - 41% open · ⏱️ 20.07.2024)
  • PyPi (📥 1.4K / month):
     pip install mkdocs-publisher
    
  • Add to mkdocs.yml:
    plugins:
      - pub-obsidian
MkDocs Backend for Foliant - 🥉12 · ⭐ 3 · 💤 · MIT
MkDocs backend for Foliant.
  • GitHub (👨‍💻 5 · 🔀 3 · 📦 32 · ⏱️ 12.12.2022)
  • PyPi (📥 230 / 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 (📥 43 / month):
     pip install mkdocs-licenseinfo
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs_licenseinfo

🌍 Internationalization & localization

Back to top

static-i18n - 🥇24 · ⭐ 220 · MIT ·
MkDocs i18n plugin using static translation markdown files.
  • GitHub (👨‍💻 11 · 🔀 36 · 📦 1.1K · 📋 140 - 13% open · ⏱️ 30.05.2024)
  • PyPi (📥 82K / month):
     pip install mkdocs-static-i18n
    
  • Add to mkdocs.yml:
    plugins:
      - i18n
mkdocs-mdpo - 🥉11 · ⭐ 7 · BSD-3 ·
Mkdocs translation plugin using PO files.
  • GitHub (👨‍💻 4 · 🔀 5 · 📥 160 · 📋 37 - 35% open · ⏱️ 10.06.2024)
  • PyPi (📥 340 / month):
     pip install mkdocs-mdpo-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - mdpo
Mkdocs translations plugin - 🥉2 · ❗Unlicensed ·
Internationalization plugin for mkdocs.
  • PyPi (📥 22 / month):
     pip install mkdocs-translations
    
  • Add to mkdocs.yml:
    plugins:
      - translations

🔗 Links & references

Back to top

mkdocs-redirects - 🥇23 · ⭐ 170 · MIT ·
Open source plugin for Mkdocs page redirects.
  • GitHub (👨‍💻 15 · 🔀 20 · 📦 3.7K · 📋 33 - 36% open · ⏱️ 24.06.2024)
  • PyPi (📥 230K / month):
     pip install mkdocs-redirects
    
  • Add to mkdocs.yml:
    plugins:
      - redirects
bibtex - 🥇20 · ⭐ 68 · ❗️BSD-3-Clause-LBNL ·
A MkDocs plugin for citation management using bibtex.
  • GitHub (👨‍💻 13 · 🔀 19 · 📦 290 · 📋 43 - 25% open · ⏱️ 01.07.2024)
  • PyPi (📥 51K / month):
     pip install mkdocs-bibtex
    
  • Add to mkdocs.yml:
    plugins:
      - bibtex
htmlproofer - 🥇20 · ⭐ 40 · MIT ·
A MkDocs plugin that validates URL in rendered html files.
  • GitHub (👨‍💻 14 · 🔀 16 · 📦 360 · 📋 35 - 5% open · ⏱️ 12.06.2024)
  • PyPi (📥 41K / month):
     pip install mkdocs-htmlproofer-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - htmlproofer
autorefs - 🥈19 · ⭐ 45 · 📈 · ISC ·
Automatically link across pages in MkDocs.
  • GitHub (👨‍💻 8 · 🔀 7 · 📋 17 - 29% open · ⏱️ 24.07.2024)
  • PyPi (📥 1.2M / month):
     pip install mkdocs-autorefs
    
  • Add to mkdocs.yml:
    plugins:
      - autorefs
autolinks - 🥈17 · ⭐ 78 · MIT ·
An MkDocs plugin that automagically generates relative links between markdown pages.
  • GitHub (👨‍💻 10 · 🔀 16 · 📦 410 · 📋 17 - 47% open · ⏱️ 04.08.2023)
  • PyPi (📥 26K / month):
     pip install mkdocs-autolinks-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - autolinks
ezlinks - 🥈14 · ⭐ 34 · 💤 · MIT ·
Plugin for mkdocs which enables easier linking between pages.
  • GitHub (🔀 13 · 📥 150 · 📦 110 · 📋 24 - 41% open · ⏱️ 24.01.2022)
  • PyPi (📥 5.6K / month):
     pip install mkdocs-ezlinks-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - ezlinks
mkdocs-open-in-new-tab - 🥈14 · ⭐ 21 · MIT ·
This plugin adds JS to open outgoing links and PDFs in a new tab.
  • GitHub (🔀 2 · 📦 220 · 📋 3 - 66% open · ⏱️ 18.06.2024)
  • PyPi (📥 24K / month):
     pip install mkdocs-open-in-new-tab
    
  • Add to mkdocs.yml:
    plugins:
      - open-in-new-tab
roamlinks - 🥈12 · ⭐ 48 · 💤 · MIT ·
An MkDocs plugin that automagically generates relative links between markdown pages.
  • GitHub (👨‍💻 9 · 🔀 15 · ⏱️ 08.06.2023)
  • PyPi (📥 8.9K / month):
     pip install mkdocs-roamlinks-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - roamlinks
Autolink References - 🥈12 · ⭐ 16 · MIT ·
mkdocs plugin to provides GitHub like autolink references in Mkdocs.
  • GitHub (👨‍💻 3 · 🔀 6 · 📦 8 · 📋 4 - 25% open · ⏱️ 28.12.2023)
  • PyPi (📥 5.5K / month):
     pip install autolink-references-mkdocs-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - autolink_references
mkdocs-alias-plugin - 🥈12 · ⭐ 11 · MIT ·
An MkDocs plugin allowing links to your pages using a custom alias.
  • GitHub (👨‍💻 3 · 🔀 2 · 📦 17 · 📋 9 - 22% open · ⏱️ 22.04.2024)
  • PyPi (📥 920 / month):
     pip install mkdocs-alias-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - alias
mkdocs-site-urls - 🥉11 · ⭐ 15 · MIT ·
A MkDocs plugin that adds support for site-relative `site:` URLs.
  • GitHub (🔀 1 · 📦 13 · 📋 2 - 50% open · ⏱️ 31.07.2023)
  • PyPi (📥 8.1K / month):
     pip install mkdocs-site-urls
    
  • Add to mkdocs.yml:
    plugins:
      - site-urls
unused-files - 🥉11 · ⭐ 8 · MIT ·
An MkDocs plugin to find unused (orphaned) files in your project.
  • GitHub (👨‍💻 2 · 🔀 1 · 📦 21 · ⏱️ 17.07.2023)
  • PyPi (📥 3.2K / month):
     pip install mkdocs-unused-files
    
  • Add to mkdocs.yml:
    plugins:
      - unused_files
link-marker - 🥉10 · ⭐ 4 · MIT ·
MkDocs plugin for marking links e.g. external ones or mails.
  • GitHub (👨‍💻 2 · 🔀 1 · 📦 14 · 📋 4 - 50% open · ⏱️ 25.02.2024)
  • PyPi (📥 1.8K / month):
     pip install mkdocs-link-marker
    
  • Add to mkdocs.yml:
    plugins:
      - link-marker
tooltipster-links - 🥉9 · ⭐ 8 · 💤 · MIT ·
An MkDocs plugin that adds tooltips to preview the content of page links using tooltipster.
  • GitHub (🔀 1 · 📦 24 · ⏱️ 29.07.2020)
  • PyPi (📥 250 / month):
     pip install mkdocs-tooltipster-links-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - tooltipster-links
abs-to-rel - 🥉9 · ⭐ 3 · 💤 · MIT ·
MkDocs plugin for converting absolute links to relative ones.
  • GitHub (👨‍💻 2 · 🔀 3 · 📦 25 · ⏱️ 03.03.2020)
  • PyPi (📥 3.7K / month):
     pip install mkdocs-abs-rel-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - abs-to-rel
mkdocs-issues-plugin - 🥉9 · ➕ · MIT ·
A plugin for showing the state and labels of issues, PRs and discussions (GitHub or GitLab) in mkdocs generated docs.
  • GitHub (👨‍💻 3 · ⏱️ 24.07.2024)
  • PyPi (📥 910 / month):
     pip install mkdocs-issues-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-issues-plugin
Wikilink Plus - 🥉8 · ⭐ 15 · 💤 · ❗Unlicensed ·
A wikilink extension for Python Markdown.
  • GitHub (👨‍💻 5 · 🔀 4 · ⏱️ 26.07.2022)
  • PyPi (📥 2.3K / month):
     pip install mdx-wikilink-plus
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mdx_wikilink_plus
ezglossary - 🥉8 · ⭐ 8 · 📉 · MIT ·
Glossary support for mkdocs.
  • GitHub (👨‍💻 2 · 🔀 1 · 📋 17 - 11% open · ⏱️ 08.05.2024)
  • PyPi (📥 3K / month):
     pip install mkdocs-ezglossary-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - ezglossary
webcontext - 🥉6 · ⭐ 1 · 💤 · MIT ·
Mkdocs plugin for converting absolute paths to webcontext aware paths using the configured webcontext context.
  • GitHub (👨‍💻 2 · 🔀 1 · 📥 6 · 📦 5 · ⏱️ 25.05.2023)
  • PyPi (📥 150 / month):
     pip install mkdocs-webcontext-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - webcontext
ArgRef - 🥉6 · 🐣 · ❗Unlicensed ·
mkdocs plugin to provides GitHub like autolink references in Mkdocs.
  • GitHub (👨‍💻 4 · ⏱️ 08.06.2024)
  • PyPi (📥 930 / month):
     pip install mkdocs-argref-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - argref
emailprotect - 🥉4 · ⭐ 4 · 💤 · MIT ·
A MkDocs plugin that tries to obscure email-addresses from address-harvesting spam-bots.
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
Mkdocs-Addresses - 🥉3 · ❗Unlicensed ·
Mkdocs plugin, building automatically the appropriate relative paths (to images, links, anchors, ...) using..
  • PyPi (📥 120 / month):
     pip install mkdocs-addresses
    
  • GitLab (🔀 0 · ⏱️ 13.07.2023)
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-addresses

🧩 Markdown extensions

Back to top

PyMdown Extensions - 🥇32 · ⭐ 930 · ❗Unlicensed ·
Extensions for Python Markdown.
  • GitHub (👨‍💻 46 · 🔀 250 · 📦 34K · 📋 370 - 2% open · ⏱️ 15.07.2024)
  • PyPi (📥 4.6M / 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 · ⭐ 27 · MIT ·
Markdown extension: a classier syntax for admonitions.
  • GitHub (🔀 12 · 📦 260 · 📋 11 - 27% open · ⏱️ 03.02.2024)
  • PyPi (📥 39K / month):
     pip install markdown-callouts
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - callouts
      - github-callouts
mkdocs-callouts - 🥇17 · ⭐ 25 · 📈 · MIT ·
A simple MkDocs plugin that converts Obsidian callout blocks to mkdocs supported Admonitions.
  • GitHub (👨‍💻 2 · 🔀 1 · 📦 1.1K · ⏱️ 05.03.2024)
  • PyPi (📥 9.2K / month):
     pip install mkdocs-callouts
    
  • Add to mkdocs.yml:
    plugins:
      - callouts
Math extension - 🥈15 · ⭐ 120 · 💤 · BSD-3 ·
Math extension for Python-Markdown.
  • GitHub (👨‍💻 8 · 🔀 25 · 📋 24 - 8% open · ⏱️ 12.08.2022)
  • PyPi (📥 83K / month):
     pip install python-markdown-math
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mdx_math
Mdx Truly Sane Lists - 🥈15 · ⭐ 81 · 💤 · MIT ·
Extension for Python-Markdown that makes lists truly sane. Custom indents for nested lists and fix for messy..
  • GitHub (👨‍💻 4 · 🔀 10 · 📋 15 - 46% open · ⏱️ 19.07.2022)
  • PyPi (📥 530K / month):
     pip install mdx-truly-sane-lists
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mdx_truly_sane_lists
YAML metadata - 🥈15 · ⭐ 20 · MIT ·
YAML metadata extension for Python-Markdown.
  • GitHub (👨‍💻 7 · 🔀 4 · 📦 82 · 📋 10 - 30% open · ⏱️ 03.07.2024)
  • PyPi (📥 1.2K / month):
     pip install markdown-full-yaml-metadata
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - full_yaml_metadata
Markdown Inline Graphviz - 🥈13 · ⭐ 5 · MIT ·
Render inline graphs with Markdown and Graphviz.
  • GitHub (👨‍💻 9 · 🔀 8 · ⏱️ 16.01.2024)
  • PyPi (📥 210K / month):
     pip install markdown-inline-graphviz-extension
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - markdown_inline_graphviz
MarkdownSuperscript - 🥈12 · ⭐ 2 · 💤 · BSD-2 ·
An extension to the Python Markdown package enabling superscript text.
  • GitHub (👨‍💻 2 · 🔀 3 · 📦 44 · 📋 4 - 25% open · ⏱️ 02.12.2018)
  • PyPi (📥 1.6K / month):
     pip install MarkdownSuperscript
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - superscript
Markdown Checklist - 🥈11 · ⭐ 78 · 💤 · MIT ·
Python Markdown extension for lists of tasks with checkboxes.
  • GitHub (👨‍💻 2 · 🔀 31 · 📋 8 - 12% open · ⏱️ 29.07.2022)
  • PyPi (📥 6.2K / 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 · 📦 57 · 📋 5 - 40% open · ⏱️ 02.12.2018)
  • PyPi (📥 250 / month):
     pip install MarkdownSubscript
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - subscript
Breakless Lists - 🥈9 · ⭐ 6 · 💤 · 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
python-asciimathml - 🥉8 · ⭐ 4 · 💤 · ❗️GPL-3.0 ·
python ASCIIMathML to Presentation MathML translator.
  • GitHub (👨‍💻 8 · 🔀 4 · ⏱️ 04.04.2017)
  • PyPi (📥 300 / month):
     pip install asciimathml
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mdx_asciimathml
markdown-icons - 🥉7 · ⭐ 12 · 💤 · ❗Unlicensed ·
Easily display icon fonts in markdown.
  • GitHub (👨‍💻 4 · 🔀 12 · 📋 7 - 42% open · ⏱️ 09.12.2018)
  • PyPi (📥 67 / month):
     pip install markdown-iconfonts
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - iconfonts
caption - 🥉7 · ⭐ 10 · 💤 · ❗️GPL-3.0 ·
  • GitHub (👨‍💻 3 · 🔀 2 · 📦 55 · 📋 8 - 87% open · ⏱️ 29.01.2023)
  • Add to mkdocs.yml:
    markdown_extensions:
      - caption
      - image_captions
      - table_captions
markdown-emdash - 🥉7 · ⭐ 3 · 💤 · MIT ·
Emdash extension for python-markdown.
  • GitHub (🔀 1 · 📦 34 · ⏱️ 18.05.2023)
  • PyPi (📥 120 / month):
     pip install markdown-emdash
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mdx_emdash
mkpatcher - 🥉7 · ⭐ 2 · 💤 · Apache-2 ·
Python-Markdown extension allowing arbitrary scripts to modify MkDocs input files.
  • GitHub (📦 7 · ⏱️ 26.04.2020)
  • PyPi (📥 260 / month):
     pip install mkpatcher
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mkpatcher
Tweetable quotes - 🥉6 · ⭐ 15 · 💤 · MIT ·
Python-Markdown extension to embed tweetable quotes into your blog posts.
  • GitHub (🔀 1 · 📦 3 · ⏱️ 25.03.2019)
  • PyPi (📥 42 / month):
     pip install markdown-tweetable
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - tweetable.extension
markdown-katex - 🥉6 · ⭐ 11 · 💤 · ❗Unlicensed ·
KaTeX extension for Python Markdown.
  • PyPi (📥 4.8K / month):
     pip install markdown-katex
    
  • GitLab (🔀 5 · 📋 17 - 23% open · ⏱️ 14.05.2019)
  • Add to mkdocs.yml:
    markdown_extensions:
      - markdown_katex
HEARTBEATS Flavored Markdown - 🥉5 · ⭐ 15 · 💤 · ❗Unlicensed ·
HEARTBEATS Flavored Markdown extension.
  • GitHub (👨‍💻 2 · 🔀 1 · 📦 9 · ⏱️ 01.03.2018)
  • PyPi (📥 250 / month):
     pip install hbfm
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - hbfm.inline_coloring
      - hbfm.inline_list
      - hbfm.number_headers
      - hbfm.quote_uri_hash
KBD Extension - 🥉5 · ⭐ 2 · 💤 · MIT ·
KBD Extension for Python-Markdown.
  • GitHub (🔀 1 · 📦 8 · ⏱️ 08.06.2020)
  • PyPi (📥 260 / month):
     pip install kbdextension
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - kbdextension
Markdown Grid Tables - 🥉5 · ⭐ 1 · 💤 · ❗Unlicensed ·
[Python-Markdown](https://python-markdown.github.io/) [extension](https://python-markdown.github.io/extensions/api/)..
  • PyPi (📥 3.8K / 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 (📥 6 / month):
     pip install mdx-cite
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mdx_cite
markdown_sub_sup - 🥉4 · ⭐ 1 · 💤 · ❗️LGPL-3.0 ·
A python markdown extension for add sub and sup support.
  • GitHub (⏱️ 24.03.2023)
  • PyPi (📥 30 / 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 (📥 940 / month):
     pip install markdown-del-ins
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - markdown_del_ins
Markdown PyCon - 🥉3 · ISC ·
Markdown extension to parse `pycon` code blocks without indentation or fences. Only available to sponsors.
Semantic WikiLinks Extension - 🥉2 · ⭐ 8 · 💤 · ❗Unlicensed ·
Python-Markdown extension to add support for semantic (wiki)links (RDFa).
  • GitHub (🔀 1 · ⏱️ 15.08.2012)
  • PyPi (📥 12 / 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 (📥 7 / month):
     pip install mdx-semanticdata
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mdx_semanticdata
Django Static Image · ❗Unlicensed ·
  • PyPi (📥 5 / month):
     pip install markdown-djangostaticimage
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - django_static_image

🧭 Navigation & page building

Back to top

awesome-pages - 🥇24 · ⭐ 460 · MIT ·
An MkDocs plugin that simplifies configuring page titles and their order.
  • GitHub (👨‍💻 8 · 🔀 36 · 📦 4.3K · 📋 82 - 23% open · ⏱️ 09.03.2024)
  • PyPi (📥 340K / month):
     pip install mkdocs-awesome-pages-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - awesome-pages
section-index - 🥇21 · ⭐ 74 · 📈 · MIT ·
MkDocs plugin to allow clickable sections that lead to an index page.
  • GitHub (👨‍💻 3 · 🔀 8 · 📦 1.6K · 📋 19 - 31% open · ⏱️ 20.04.2024)
  • PyPi (📥 220K / month):
     pip install mkdocs-section-index
    
  • Add to mkdocs.yml:
    plugins:
      - section-index
encryptcontent - 🥇20 · ⭐ 120 · MIT ·
A MkDocs plugin that encrypt/decrypt markdown content with AES.
  • GitHub (👨‍💻 5 · 🔀 15 · 📥 87 · 📦 1.1K · 📋 62 - 1% open · ⏱️ 14.06.2024)
  • PyPi (📥 5.3K / month):
     pip install mkdocs-encryptcontent-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - encryptcontent
literate-nav - 🥈19 · ⭐ 72 · MIT ·
MkDocs plugin to specify the navigation in Markdown instead of YAML.
  • GitHub (🔀 8 · 📦 1.8K · 📋 28 - 42% open · ⏱️ 27.04.2024)
  • PyPi (📥 220K / 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 · 🔀 5 · 📥 42 · 📦 1.7K · ⏱️ 14.11.2023)
  • PyPi (📥 42K / month):
     pip install mkdocs-simple-hooks
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-simple-hooks
exclude - 🥈17 · ⭐ 85 · 💤 · Apache-2 ·
A mkdocs plugin that lets you exclude files or trees from your output.
  • GitHub (🔀 10 · 📦 2K · 📋 12 - 75% open · ⏱️ 20.02.2019)
  • PyPi (📥 170K / month):
     pip install mkdocs-exclude
    
  • Add to mkdocs.yml:
    plugins:
      - exclude
Publisher for MkDocs - meta - 🥈16 · ⭐ 44 · MIT ·
Automatic navigation based on files metadata with URL name and publication status control.
  • GitHub (👨‍💻 2 · 🔀 1 · 📥 32 · 📦 57 · 📋 17 - 41% open · ⏱️ 20.07.2024)
  • PyPi (📥 1.4K / month):
     pip install mkdocs-publisher
    
  • Add to mkdocs.yml:
    plugins:
      - pub-meta
mkdocs-gallery - 🥈16 · ⭐ 34 · BSD-3 ·
Same features as sphinx-gallery (https://sphinx-gallery.github.io/) but on mkdocs (https://www.mkdocs.org/) (no sphinx..
  • GitHub (👨‍💻 9 · 🔀 14 · 📋 65 - 40% open · ⏱️ 15.03.2024)
  • PyPi (📥 5.9K / month):
     pip install mkdocs-gallery
    
  • Add to mkdocs.yml:
    plugins:
      - gallery
file-filter - 🥈15 · ⭐ 8 · MIT ·
A MkDocs plugin that lets you exclude/include docs files using globs, regexes, gitignore-style file and..
  • GitHub (👨‍💻 4 · 🔀 3 · 📥 40 · 📦 12 · 📋 11 - 27% open · ⏱️ 19.07.2024)
  • PyPi (📥 5.7K / month):
     pip install mkdocs-file-filter-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - file-filter
mkdocs-nav-weight - 🥈12 · ⭐ 8 · MIT ·
A simple mkdocs plugin, enables to organize Navigation in a more markdownic way.
  • GitHub (👨‍💻 3 · 🔀 2 · 📦 61 · ⏱️ 17.11.2023)
  • PyPi (📥 6.3K / month):
     pip install mkdocs-nav-weight
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-nav-weight
MkRefs - 🥈11 · ⭐ 30 · MIT ·
MkDocs plugin to generate semantic reference Markdown pages from a knowledge graph.
  • GitHub (👨‍💻 2 · 📦 4 · ⏱️ 31.08.2023)
  • PyPi (📥 62 / month):
     pip install mkrefs
    
  • Add to mkdocs.yml:
    plugins:
      - mkrefs
mkdocs-pagetree-plugin - 🥈11 · ⭐ 2 · MIT ·
MkDocs plugin that allows you to display the page tree. Like `sitemap.xml`, but for humans.
  • GitHub (📦 9 · 📋 9 - 44% open · ⏱️ 14.05.2024)
  • PyPi (📥 380 / month):
     pip install mkdocs-pagetree-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - pagetree
mkdocs-categories-plugin - 🥉10 · ⭐ 12 · MIT ·
An MkDocs plugin allowing for categorization of wiki pages.
  • GitHub (📦 15 · ⏱️ 22.04.2024)
  • PyPi (📥 880 / month):
     pip install mkdocs-categories-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - categories
toc-sidebar - 🥉10 · ⭐ 6 · 💤 · MIT ·
An MkDocs plugin that allows users to add additional content to the ToC sidebar using the Material theme.
  • GitHub (👨‍💻 2 · 🔀 3 · 📦 38 · ⏱️ 11.01.2020)
  • PyPi (📥 7.2K / month):
     pip install mkdocs-toc-sidebar-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - toc-sidebar
vim-md-tags - 🥉10 · ⭐ 4 · 💤 · MIT ·
An MkDocs plugin that creates a vim tag file of all markdown files.
  • GitHub (👨‍💻 4 · 🔀 1 · 📦 11 · ⏱️ 08.05.2020)
  • PyPi (📥 300 / month):
     pip install mkdocs-vim-md-tags-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - vim-md-tags
include directory to navigation - 🥉9 · ⭐ 25 · 💤 · ❗Unlicensed ·
Simple MKDocs plugin than permit to fetch and replace directory in navigation.
  • GitHub (🔀 1 · 📥 10 · 📋 4 - 50% open · ⏱️ 01.03.2022)
  • PyPi (📥 110K / month):
     pip install mkdocs-include-dir-to-nav
    
  • Add to mkdocs.yml:
    plugins:
      - include_dir_to_nav
mkdocs-nav-enhancements - 🥉9 · ⭐ 3 · 💤 · MIT ·
WIP plugin for working with titles of pages in MkDocs.
  • GitHub (📦 34 · ⏱️ 24.07.2019)
  • PyPi (📥 6.4K / month):
     pip install mkdocs-nav-enhancements
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-nav-enhancements
mkdocs-live-edit-plugin - 🥉8 · ⭐ 11 · MIT ·
An MkDocs plugin that allows editing pages directly from the browser.
  • GitHub (👨‍💻 2 · 🔀 2 · 📦 4 · 📋 3 - 33% open · ⏱️ 07.03.2024)
  • PyPi (📥 170 / 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.8K / month):
     pip install mkdocs-schema-reader
    
  • Add to mkdocs.yml:
    plugins:
      - schema_reader
select-files - 🥉6 · 💤 · Apache-2 ·
Filter pages for assignments.
  • GitHub (📦 8 · ⏱️ 05.09.2019)
  • PyPi (📥 32 / month):
     pip install mkdocs-select-files
    
  • Add to mkdocs.yml:
    plugins:
      - select-files
mkdocs-title-casing-plugin - 🥉5 · ⭐ 2 · ❗️GPL-3.0 ·
A lightweight mkdocs plugin to add title casing to all mkdocs pages and sections.
  • GitHub (📦 2 · ⏱️ 02.09.2023)
  • PyPi (📥 1.3K / month):
     pip install mkdocs-title-casing-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - title-casing
SWAN Gallery - 🥉5 · ⭐ 1 · ❗️AGPL-3.0 ·
MkDocs plugin to generate a SWAN Gallery.
  • GitHub (👨‍💻 2 · 📦 2 · ⏱️ 20.07.2023)
  • PyPi (📥 50 / month):
     pip install mkdocs-swangallery
    
  • Add to mkdocs.yml:
    plugins:
      - swangallery
awesome-list - 🥉4 · ⭐ 5 · 💤 · MIT ·
MkDocs Plugin to inject social media cards for each entry in an awesome-list.
mkdocs-copy - 🥉3 · ⭐ 4 · 💤 · MIT ·
A MkDocs plugin that lets you copy (and maybe transform) arbitrary doc files to the build.
  • GitHub (📥 6 · 📦 1 · ⏱️ 21.09.2021)
  • PyPi (📥 9 / month):
     pip install mkdocs-copy
    
  • Add to mkdocs.yml:
    plugins:
      - copy
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 (📥 7 / month):
     pip install mkdocs-pug
    

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

Back to top

mktestdocs - 🥇18 · ⭐ 100 · Apache-2
Run pytest against markdown files/docstrings.
  • GitHub (👨‍💻 4 · 🔀 7 · 📦 57 · 📋 4 - 50% open · ⏱️ 15.07.2024)
  • PyPi (📥 11K / month):
     pip install mktestdocs
    
mkdocs-spellcheck - 🥈17 · ⭐ 15 · 📈 · ISC ·
A spell checker plugin for MkDocs.
  • GitHub (👨‍💻 4 · 🔀 3 · 📦 45 · 📋 18 - 44% open · ⏱️ 06.05.2024)
  • PyPi (📥 10K / month):
     pip install mkdocs-spellcheck
    
  • Add to mkdocs.yml:
    plugins:
      - spellcheck
Link Checker - 🥉9 · ⭐ 9 · 💤 · MIT
Python asyncio + aiohttp Markdown *.md URL link checker: 10,000 files/second.
  • GitHub (👨‍💻 5 · 🔀 4 · ⏱️ 24.08.2021)
  • PyPi (📥 4.7K / month):
     pip install mkdocs-linkcheck
    
mkdocs-code-validator - 🥉8 · ⭐ 2 · MIT ·
Checks Markdown code blocks in a MkDocs site against user-defined actions.
  • GitHub (📦 14 · ⏱️ 27.04.2024)
  • PyPi (📥 200 / 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 (📥 31 / month):
     pip install mkdocs-codecheck
    

🔍 Search & tables of content

Back to top

exclude-search - 🥇17 · ⭐ 27 · MIT ·
A mkdocs plugin that excludes selected chapters from the docs search index.
  • GitHub (👨‍💻 6 · 🔀 2 · 📥 10 · 📦 390 · ⏱️ 04.12.2023)
  • PyPi (📥 21K / month):
     pip install mkdocs-exclude-search
    
  • Add to mkdocs.yml:
    plugins:
      - exclude-search
localsearch - 🥈16 · ⭐ 32 · 💤 · MIT ·
A MkDocs plugin to make the native search plugin work locally (file:// protocol).
  • GitHub (👨‍💻 6 · 🔀 7 · 📦 80 · ⏱️ 02.01.2023)
  • PyPi (📥 4.9K / 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 (📥 810 / month):
     pip install mkdocs-plugin-tags
    
  • Add to mkdocs.yml:
    plugins:
      - tags
extract listings - 🥉8 · MIT ·
Generate a page with all listings and/or a search page for listings.
  • GitHub (⏱️ 22.06.2024)
  • PyPi (📥 750 / month):
     pip install mkdocs-extract-listings-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - extract_listings
mkdocs-task-collector - 🥉3 · ⭐ 1 · ➕ · MIT ·
  • GitHub (⏱️ 25.07.2024)
  • PyPi:
     pip install mkdocs-task-collector
    
  • Add to mkdocs.yml:
    plugins:
      - task-collector

🍱 Site conversion (PDF/ePUB/etc.)

Back to top

print-site - 🥇24 · ⭐ 130 · MIT ·
MkDocs Plugin that adds an additional page that combines all pages, allowing easy exports to PDF and standalone HTML.
  • GitHub (👨‍💻 8 · 🔀 21 · 📦 320 · 📋 94 - 14% open · ⏱️ 31.05.2024)
  • PyPi (📥 23K / month):
     pip install mkdocs-print-site-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - print-site
mkdocs-with-pdf - 🥇23 · ⭐ 320 · 💤 · MIT ·
Generate a single PDF file from MkDocs repository.
  • GitHub (👨‍💻 6 · 🔀 74 · 📦 570 · 📋 100 - 57% open · ⏱️ 14.10.2021)
  • PyPi (📥 46K / month):
     pip install mkdocs-with-pdf
    
  • Add to mkdocs.yml:
    plugins:
      - with-pdf
pdf-export - 🥈22 · ⭐ 310 · 💤 · MIT ·
An MkDocs plugin to export content pages as PDF files.
  • GitHub (👨‍💻 11 · 🔀 43 · 📦 1K · 📋 88 - 47% open · ⏱️ 05.10.2021)
  • PyPi (📥 23K / month):
     pip install mkdocs-pdf-export-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - pdf-export
mkpdfs - 🥈17 · ⭐ 100 · 💤 · ❗️GPL-3.0 ·
Converts your mkdocs documentation in PDF, to be shared with users.
  • GitHub (👨‍💻 8 · 🔀 30 · 📥 36 · 📦 57 · 📋 39 - 30% open · ⏱️ 11.08.2021)
  • PyPi (📥 1.4K / month):
     pip install mkpdfs-mkdocs
    
  • Add to mkdocs.yml:
    plugins:
      - mkpdfs
mkdocs-exporter - 🥈16 · ⭐ 65 · MIT ·
MkDocs Exporter is a powerful plugin for MkDocs that enables seamless conversion of single pages and/or the entire..
  • GitHub (👨‍💻 2 · 🔀 1 · 📦 5 · 📋 26 - 7% open · ⏱️ 23.07.2024)
  • PyPi (📥 1.9K / month):
     pip install mkdocs-exporter
    
  • Add to mkdocs.yml:
    plugins:
      - exporter
mkdocs-pandoc - 🥉14 · ⭐ 110 · 💤 · Apache-2
[unmaintained] mkdocs - pandoc converter: use this fork https://github.com/twardoch/mkdocs-combine.
  • GitHub (👨‍💻 4 · 🔀 22 · 📦 51 · 📋 23 - 56% open · ⏱️ 14.03.2016)
  • PyPi (📥 250 / month):
     pip install mkdocs-pandoc
    
pdf-with-js - 🥉11 · ⭐ 7 · 💤 · MIT ·
A MkDocs plugin that exports your documentation as PDF with rendered JavaScript content.
  • GitHub (👨‍💻 4 · 🔀 2 · 📦 12 · ⏱️ 23.07.2021)
  • PyPi (📥 1.1K / month):
     pip install mkdocs-pdf-with-js-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - pdf-with-js
mk2pdf-export - 🥉6 · ⭐ 8 · 💤 · MIT ·
The plugin is based on https://github.com/zhaoterryy/mkdocs-pdf-export-plugin/ ,the main change is use pandoc to..
  • GitHub (👨‍💻 4 · 🔀 5 · 📦 2 · ⏱️ 11.09.2020)
  • PyPi (📥 52 / month):
     pip install mkdocs-mk2pdf-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - mk2pdf-export
mkdocs-zip-folders - 🥉6 · ⭐ 2 · MIT ·
MkDocs plugin to zip configured folders and add them to the site.
  • GitHub (⏱️ 09.07.2023)
  • PyPi (📥 760 / 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 (📥 33 / 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 (📥 250 / month):
     pip install mkdocs-autozip
    
  • Add to mkdocs.yml:
    plugins:
      - autozip

🔧 Site building, site management

Back to top

mike - 🥇28 · ⭐ 510 · BSD-3 ·
Manage multiple versions of your MkDocs-powered documentation via Git.
  • GitHub (👨‍💻 9 · 🔀 44 · 📥 230 · 📦 3.1K · 📋 180 - 5% open · ⏱️ 24.06.2024)
  • PyPi (📥 380K / month):
     pip install mike
    
  • Add to mkdocs.yml:
    plugins:
      - mike
monorepo - 🥇23 · ⭐ 310 · Apache-2 ·
Build multiple documentation folders in a single Mkdocs. Designed for large codebases.
  • GitHub (👨‍💻 30 · 🔀 73 · 📦 430 · 📋 64 - 53% open · ⏱️ 04.01.2024)
  • PyPi (📥 320K / month):
     pip install mkdocs-monorepo-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - monorepo
mkdocs-multirepo-plugin - 🥇22 · ⭐ 120 · MIT ·
Build documentation in multiple repos into one site.
  • GitHub (👨‍💻 16 · 🔀 43 · 📦 120 · 📋 97 - 47% open · ⏱️ 24.06.2024)
  • PyPi (📥 57K / month):
     pip install mkdocs-multirepo-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - multirepo
techdocs-core - 🥇22 · ⭐ 85 · Apache-2 ·
The core MkDocs plugin used by Backstages TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown..
  • GitHub (👨‍💻 39 · 🔀 61 · 📦 60 · 📋 61 - 9% open · ⏱️ 26.06.2024)
  • PyPi (📥 280K / month):
     pip install mkdocs-techdocs-core
    
  • Add to mkdocs.yml:
    plugins:
      - techdocs-core
simple - 🥈21 · ⭐ 40 · Apache-2 ·
Build documentation files inside your code into a MkDocs site.
  • GitHub (👨‍💻 8 · 🔀 10 · 📦 50 · ⏱️ 18.07.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 · 📦 79 · 📋 25 - 12% open · ⏱️ 01.08.2021)
  • PyPi (📥 3.3K / month):
     pip install mkdocs-versioning
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-versioning
markdown-docs - 🥈17 · ⭐ 17 · MIT ·
Action/docker image that transforms your markdown into a static website. No need for particular configuration: it just..
  • GitHub (👨‍💻 4 · 🔀 6 · 📦 58 · 📋 27 - 3% open · ⏱️ 17.07.2024)
  • Docker Hub (📥 18K · ⏱️ 17.07.2024):
     docker pull deloo/markdown-docs
    
Publisher for MkDocs - debugger - 🥈16 · ⭐ 44 · MIT ·
Advanced console and file logger from build and serve process.
  • GitHub (👨‍💻 2 · 🔀 1 · 📥 32 · 📦 57 · 📋 17 - 41% open · ⏱️ 20.07.2024)
  • PyPi (📥 1.4K / month):
     pip install mkdocs-publisher
    
  • Add to mkdocs.yml:
    plugins:
      - pub-debugger
same-dir - 🥈14 · ⭐ 34 · MIT ·
MkDocs plugin to allow placing mkdocs.yml in the same directory as documentation.
  • GitHub (👨‍💻 2 · 🔀 2 · 📦 310 · ⏱️ 03.02.2024)
  • PyPi (📥 28K / 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 · 📦 5 · 📋 9 - 66% open · ⏱️ 21.01.2023)
  • PyPi (📥 1.8K / month):
     pip install mkdocs-merge
    
mkdocs-exclude-unused-files - 🥉13 · ⭐ 3 · MIT ·
Exclude orphaned (unused) static files from your mkdocs build.
  • GitHub (👨‍💻 3 · 🔀 1 · 📦 12 · ⏱️ 09.06.2024)
  • PyPi (📥 1.9K / month):
     pip install mkdocs-exclude-unused-files
    
  • Add to mkdocs.yml:
    plugins:
      - exclude-unused-files
multirepo - 🥉11 · ⭐ 37 · MIT
A bit like monorepo, but keeps MkDocs projects separate.
  • GitHub (👨‍💻 3 · 🔀 2 · 📦 1 · ⏱️ 04.01.2024)
  • PyPi (📥 610 / month):
     pip install mkdocs-multirepo
    
mkdocs-auto-refresh-build-pages - 🥉9 · 🐣 · MIT ·
MkDocs plugin that automatically refreshes the build pages when the documentation is updated.
  • GitHub (📦 3 · ⏱️ 02.07.2024)
  • PyPi (📥 620 / month):
     pip install mkdocs-auto-refresh-build-pages
    
  • Add to mkdocs.yml:
    plugins:
      - auto-refresh-build-pages
mkdocs-yamp - 🥉8 · ⭐ 1 · 💤 · Apache-2 ·
Yet Another Multirepo Plugin for MkDocs.
  • GitHub (👨‍💻 2 · 🔀 3 · 📦 5 · ⏱️ 10.10.2022)
  • PyPi (📥 64 / month):
     pip install mkdocs-yamp
    
  • Add to mkdocs.yml:
    plugins:
      - yamp
mkdocs-required-frontmatter-plugin - 🥉7 · 🐣 · MIT ·
This MkDocs plugin enforces required frontmatter for documentation pages.
  • GitHub (📦 1 · ⏱️ 22.03.2024)
  • PyPi (📥 21 / month):
     pip install mkdocs-required-frontmatter-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - required-frontmatter
progress - 🥉6 · ⭐ 5 · 💤 · Apache-2 ·
A plugin for MkDocs that lets you know exactly what is happening during the build.
  • GitHub (👨‍💻 3 · 📦 32 · ⏱️ 20.06.2020)
  • Add to mkdocs.yml:
    plugins:
      - progress
mkdocs-exclude-tagged-files - 🥉6 · ⭐ 3 · MIT ·
A mkdocs plugin for excluding files based on frontmatter tags.
  • GitHub (👨‍💻 2 · 🔀 2 · 📦 3 · ⏱️ 10.09.2023)
  • PyPi (📥 56 / month):
     pip install mkdocs-exclude-tagged-files
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs_exclude_tagged_files
no-sitemap - 🥉6 · ⭐ 1 · 💤 · MIT ·
Disable Mkdocs sitemap generation.
  • GitHub (📦 9 · ⏱️ 04.04.2023)
  • PyPi (📥 3.1K / month):
     pip install mkdocs-no-sitemap-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - no-sitemap
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 (📥 910 / 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 (📥 960 / 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 (📦 1 · ⏱️ 22.08.2021)
  • PyPi (📥 19 / month):
     pip install octadocs-adr
    
  • Add to mkdocs.yml:
    plugins:
      - octadocs_adr

📁 Snippets & includes (reusing contents)

Back to top

include-markdown - 🥇25 · ⭐ 99 · Apache-2 ·
Mkdocs Markdown includer plugin.
  • GitHub (👨‍💻 16 · 🔀 19 · 📥 300 · 📦 2.2K · 📋 80 - 3% open · ⏱️ 01.07.2024)
  • PyPi (📥 250K / month):
     pip install mkdocs-include-markdown-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - include-markdown
Markdown-Include - 🥈22 · ⭐ 97 · 💤 · ❗️GPL-3.0 ·
Provides syntax for Python-Markdown which allows for the inclusion of the contents of other Markdown documents.
  • GitHub (👨‍💻 12 · 🔀 36 · 📦 6.1K · 📋 24 - 29% open · ⏱️ 07.02.2023)
  • PyPi (📥 130K / month):
     pip install markdown-include
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - markdown_include.include
meta-descriptions - 🥈19 · ⭐ 16 · MIT ·
Generate meta descriptions from the first paragraphs in your MkDocs pages.
  • GitHub (👨‍💻 3 · 🔀 3 · 📦 1.1K · 📋 11 - 9% open · ⏱️ 17.07.2024)
  • PyPi (📥 6.3K / month):
     pip install mkdocs-meta-descriptions-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - meta-descriptions
codeinclude - 🥈16 · ⭐ 14 · 💤 · MIT ·
A plugin to include code snippets into mkdocs pages.
  • GitHub (👨‍💻 4 · 🔀 6 · 📦 130 · 📋 12 - 41% open · ⏱️ 01.03.2023)
  • PyPi (📥 12K / month):
     pip install mkdocs-codeinclude-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - codeinclude
mkdocs-embed-external-markdown - 🥉15 · ⭐ 9 · MIT ·
MkDocs Embed External Markdown plugin that allow to inject section or all full markdown content from a given url. The..
  • GitHub (👨‍💻 6 · 🔀 7 · 📦 120 · ⏱️ 26.02.2024)
  • PyPi (📥 6.9K / month):
     pip install mkdocs-embed-external-markdown
    
  • Add to mkdocs.yml:
    plugins:
      - external-markdown
markdown-version-annotations - 🥉13 · ⭐ 5 · MIT ·
MkDocs plugin to add custom admonitions for documenting version differences.
  • GitHub (📥 12 · 📦 10 · ⏱️ 06.05.2024)
  • PyPi (📥 2.6K / month):
     pip install markdown-version-annotations
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - markdown_version_annotations
snippet - 🥉11 · ⭐ 12 · 💤 · MIT ·
An mkdocs plugin that injects snippets from a file in a git repository.
  • GitHub (👨‍💻 3 · 🔀 3 · 📦 17 · 📋 7 - 42% open · ⏱️ 21.10.2021)
  • PyPi (📥 1.4K / month):
     pip install mkdocs-snippet-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - snippet
Mdx Include - 🥉10 · ⭐ 53 · 💤 · ❗Unlicensed ·
Python Markdown extension to include local or remote files.
  • GitHub (👨‍💻 3 · 🔀 3 · 📋 9 - 44% open · ⏱️ 26.07.2022)
  • PyPi (📥 27K / month):
     pip install mdx-include
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mdx_include
git snippet - 🥉8 · ⭐ 6 · 💤 · MIT ·
Mkdocs plugin that allow to inject snippet or all markdown content from a given remote git repository.
  • GitHub (👨‍💻 4 · 🔀 3 · 📦 8 · ⏱️ 15.11.2020)
  • PyPi (📥 840 / 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.

License

CC0

About

🏆 📚 A list of awesome MkDocs projects and plugins.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%