Skip to content

Latest commit

 

History

History
2959 lines (2652 loc) · 173 KB

README.md

File metadata and controls

2959 lines (2652 loc) · 173 KB

catalog

🏆 📚 A list of awesome MkDocs projects and plugins.

This list contains 220 awesome open-source projects with a total of 25K stars grouped into 18 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 · ⭐ 15K · MIT · ·
Documentation that simply works.
  • GitHub (👨‍💻 230 · 🔀 3K · 📦 37K · 📋 2K - 1% open · ⏱️ 21.09.2023)
  • PyPi (📥 3.1M / month):
     pip install mkdocs-material
    
  • Add to mkdocs.yml:
    theme: material
    plugins:
      - offline
      - search
      - social
      - tags
Cinder - 🥇20 · ⭐ 190 · 💤 · ❗Unlicensed ·
A clean, responsive MkDocs theme.
  • GitHub (👨‍💻 23 · 🔀 99 · 📥 970 · 📦 560 · 📋 51 - 31% open · ⏱️ 05.01.2021)
  • PyPi (📥 5.1K / month):
     pip install mkdocs-cinder
    
  • Add to mkdocs.yml:
    theme: cinder
Bootswatch - 🥇19 · ⭐ 130 · 💤 · BSD-2 ·
MkDocs Bootswatch Themes.
  • GitHub (👨‍💻 10 · 🔀 58 · 📦 1K · 📋 33 - 9% open · ⏱️ 27.02.2020)
  • PyPi (📥 9.3K / 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
Simple Blog - 🥇17 · ⭐ 28 · MIT ·
Blog Template for Mkdocs.
  • GitHub (👨‍💻 3 · 🔀 4 · 📦 29 · 📋 15 - 33% open · ⏱️ 20.08.2023)
  • PyPi (📥 250 / month):
     pip install mkdocs-simple-blog
    
  • Add to mkdocs.yml:
    theme: simple-blog
Bootstrap - 🥈16 · ⭐ 73 · BSD-2 ·
MkDocs Bootstrap Theme.
  • GitHub (👨‍💻 6 · 🔀 37 · 📦 440 · 📋 16 - 18% open · ⏱️ 28.07.2023)
  • PyPi (📥 2.8K / month):
     pip install mkdocs-bootstrap
    
  • Add to mkdocs.yml:
    theme: bootstrap
Dracula - 🥈16 · ⭐ 23 · 🐣 · MIT ·
Dark theme for Mkdocs.
  • GitHub (👨‍💻 3 · 🔀 2 · 📦 12 · 📋 6 - 16% open · ⏱️ 09.07.2023)
  • PyPi (📥 430 / month):
     pip install mkdocs-dracula-theme
    
  • Add to mkdocs.yml:
    theme: dracula
Terminal for MkDocs - 🥈15 · ⭐ 33 · MIT ·
monospace theme for MkDocs.
  • GitHub (🔀 1 · 📦 33 · 📋 54 - 46% open · ⏱️ 15.04.2023)
  • PyPi (📥 410 / month):
     pip install mkdocs-terminal
    
  • Add to mkdocs.yml:
    theme: terminal
Windmill - 🥈14 · ⭐ 96 · 💤 · ❗Unlicensed ·
Outstanding mkdocs theme with a focus on navigation and usability.
  • GitHub (👨‍💻 8 · 🔀 45 · 📦 260 · 📋 30 - 46% open · ⏱️ 11.03.2022)
  • PyPi (📥 2.4K / month):
     pip install mkdocs-windmill
    
  • Add to mkdocs.yml:
    theme: windmill
Bootstrap4 - 🥈12 · ⭐ 44 · 💤 · MIT ·
Bootstrap 4.0+ theme for MkDocs.
  • GitHub (👨‍💻 4 · 🔀 10 · 📦 93 · ⏱️ 05.11.2020)
  • PyPi (📥 1K / month):
     pip install mkdocs-bootstrap4
    
  • Add to mkdocs.yml:
    theme: bootstrap4
Alabaster - 🥉8 · ⭐ 36 · 💤 · ❗Unlicensed ·
Alabaster port for MkDocs.
  • GitHub (👨‍💻 9 · 🔀 9 · 📋 17 - 17% open · ⏱️ 16.06.2020)
  • PyPi (📥 270 / month):
     pip install mkdocs-alabaster
    
  • Add to mkdocs.yml:
    theme: alabaster
Windmill Dark - 🥉8 · ⭐ 31 · 💤 · ❗Unlicensed ·
Outstanding mkdocs theme with a focus on navigation and usability.
  • GitHub (👨‍💻 4 · 🔀 10 · ⏱️ 12.05.2022)
  • PyPi (📥 400 / month):
     pip install mkdocs-windmill-dark
    
  • Add to mkdocs.yml:
    theme: windmill-dark
GitBook - 🥉7 · ⭐ 27 · 💤 · ❗Unlicensed ·
Default theme for GitBook for Mkdocs https://lramage.gitlab.io/mkdocs-gitbook-theme.
  • PyPi (📥 6.5K / month):
     pip install mkdocs-gitbook
    
  • GitLab (🔀 12 · 📋 17 - 41% open · ⏱️ 17.12.2018)
  • Add to mkdocs.yml:
    theme: gitbook
BOOTSTRAP386 - 🥉6 · ⭐ 30 · 💤 · ❗Unlicensed ·
A vintage 1980s DOS inspired Twitter Bootstrap theme for MkDocs https://lramage.gitlab.io/mkdocs-bootstrap386.
  • PyPi (📥 3.8K / month):
     pip install mkdocs-bootstrap386
    
  • GitLab (🔀 2 · 📋 7 - 57% open · ⏱️ 06.06.2018)
  • Add to mkdocs.yml:
    theme: bootstrap386
Show 19 hidden projects...
Lantana - 🥈12 · ⭐ 9 · MIT ·
Lantana MKDocsHTML.
  • GitHub (👨‍💻 3 · 📥 160 · 📦 1 · 📋 18 - 11% open · ⏱️ 26.08.2023)
  • PyPi (📥 610 / month):
     pip install lantana
    
  • Add to mkdocs.yml:
    theme: lantana
Ivory - 🥈11 · ⭐ 11 · 💤 · MIT ·
Ivory theme for MkDocs.
  • GitHub (👨‍💻 2 · 🔀 4 · 📦 63 · 📋 5 - 40% open · ⏱️ 16.06.2020)
  • PyPi (📥 5.5K / month):
     pip install mkdocs-ivory
    
  • Add to mkdocs.yml:
    theme: ivory
KPN for MkDocs - 🥈10 · ⭐ 7 · MIT ·
KPN theme for MkDocs | owner=flow.
  • GitHub (👨‍💻 3 · 📦 2 · ⏱️ 25.07.2023)
  • PyPi (📥 770 / month):
     pip install mkdocs-kpn
    
  • Add to mkdocs.yml:
    theme: kpn
CustomMill - 🥈9 · ⭐ 11 · 💤 · ❗Unlicensed ·
Outstanding mkdocs theme with a focus on navigation, customization and usability.
  • GitHub (👨‍💻 8 · 🔀 6 · 📦 13 · ⏱️ 10.03.2022)
  • PyPi (📥 170 / month):
     pip install mkdocs-custommill
    
  • Add to mkdocs.yml:
    theme: custommill
Semantic - 🥈9 · ⭐ 6 · 💤 · MIT ·
Semantic-UI Theme for MkDocs.
  • GitHub (👨‍💻 6 · 🔀 3 · 📦 5 · ⏱️ 30.03.2021)
  • PyPi (📥 36 / month):
     pip install mkdocs-semantic
    
  • Add to mkdocs.yml:
    theme: semantic
Bootstrap 4 - 🥈9 · ⭐ 4 · MIT ·
A vanilla Bootstrap 4 theme for MkDocs.
  • GitHub (👨‍💻 3 · 📦 2 · 📋 5 - 20% open · ⏱️ 07.01.2023)
  • PyPi (📥 120 / month):
     pip install mkdocs-theme-bootstrap4
    
  • Add to mkdocs.yml:
    theme: bootstrap4
Risonia - 🥈9 · ⭐ 1 · ❗Unlicensed ·
A simple theme for MkDocs, using the w3.css framework and configurable color schemes.
  • GitHub (⏱️ 01.09.2023)
  • PyPi (📥 160 / month):
     pip install mkdocs-risonia-theme
    
  • Add to mkdocs.yml:
    theme: risonia
Jinks - 🥉8 · ⭐ 16 · 💤 · BSD-2 ·
Mkdocs jinks theme.
  • GitHub (👨‍💻 7 · 🔀 4 · 📦 4 · ⏱️ 08.11.2019)
  • PyPi (📥 14 / month):
     pip install mkdocs-jinks
    
  • Add to mkdocs.yml:
    theme: jinks_en
Zettelkasten - 🥉8 · ⭐ 4 · MIT ·
This is a Zettelkasten theme and plugin for MkDocs. It renders the MkDocs pages as cards (zettels).
  • GitHub (👨‍💻 3 · 📥 19 · 📦 2 · 📋 9 - 66% open · ⏱️ 05.09.2023)
  • PyPi (📥 46 / month):
     pip install mkdocs-zettelkasten
    
  • Add to mkdocs.yml:
    theme: zettelkasten-solarized-light
SWAN - 🥉8 · ⭐ 2 · ❗️AGPL-3.0 ·
SWAN MkDocs theme.
  • GitHub (👨‍💻 2 · 🔀 1 · 📦 3 · ⏱️ 20.07.2023)
  • PyPi (📥 57 / month):
     pip install mkdocs-swan
    
  • Add to mkdocs.yml:
    theme: swan
Nature - 🥉7 · ⭐ 4 · ❗Unlicensed ·
A MkDocs theme.
  • GitHub (👨‍💻 2 · 🔀 1 · 📦 38 · ⏱️ 14.09.2023)
  • PyPi (📥 570 / month):
     pip install mkdocs-nature
    
  • Add to mkdocs.yml:
    theme: nature
Unidata - 🥉7 · ⭐ 1 · 💤 · MIT ·
Custom MkDocs Material Design Theme.
  • GitHub (👨‍💻 16 · 🔀 2 · ⏱️ 27.09.2017)
  • PyPi (📥 49 / month):
     pip install mkdocs-unidata
    
  • Add to mkdocs.yml:
    theme: unidata
docSkimmer - 🥉5 · ⭐ 17 · 💤 · ❗Unlicensed ·
An accessible, skimmable theme for MkDocs.
mkdocs-theme-topdf - 🥉5 · ⭐ 9 · 💤 · MPL-2.0 ·
A mkdocs theme for create PDF and printing with paged.js.
  • GitHub (🔀 1 · 📦 2 · ⏱️ 26.06.2021)
  • PyPi (📥 26 / month):
     pip install mkdocs-theme-topdf
    
  • Add to mkdocs.yml:
    theme: topdf
Moonstone - 🥉5 · ⭐ 5 · 💤 · ❗Unlicensed ·
A documentation theme for mkdocs.
  • GitHub (🔀 1 · 📦 8 · ⏱️ 15.06.2021)
  • PyPi (📥 97 / month):
     pip install mkdocs-moonstone
    
  • Add to mkdocs.yml:
    theme: moonstone
GitHub - 🥉5 · ⭐ 2 · 💤 · MIT ·
Theme Mkdocs Like a Github. DEMO =.
  • GitHub (📦 7 · ⏱️ 25.02.2020)
  • PyPi (📥 41 / 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 · 🔀 5 · 📋 2 - 50% open · ⏱️ 22.10.2017)
Cluster - 🥉3 · ⭐ 4 · 💤 · ❗Unlicensed ·
Another bootstrap theme for MkDocs.
  • PyPi (📥 220 / month):
     pip install mkdocs-cluster
    
  • GitLab (🔀 1 · ⏱️ 02.06.2016)
  • Add to mkdocs.yml:
    theme: cluster
Inspired - 🥉3 · 💤 · MIT ·
Mkdocs mobile responsive theme with slider navigation inspired by bootswatch flatly.
  • GitHub (📦 2 · ⏱️ 18.07.2016)
  • PyPi (📥 19 / month):
     pip install mkdocs-inspired
    
  • Add to mkdocs.yml:
    theme: inspired

💻 API documentation building

Back to top

mkdocstrings - 🥇32 · ⭐ 1.3K · ISC ·
Automatic documentation from sources, for MkDocs.
  • GitHub (👨‍💻 39 · 🔀 94 · 📦 9.1K · 📋 360 - 12% open · ⏱️ 18.09.2023)
  • PyPi (📥 580K / month):
     pip install mkdocstrings
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocstrings
mkdocs-click - 🥇21 · ⭐ 74 · 📈 · Apache-2 ·
An MkDocs extension to generate documentation for Click command line applications.
  • GitHub (👨‍💻 13 · 🔀 16 · 📦 310 · 📋 27 - 44% open · ⏱️ 18.09.2023)
  • PyPi (📥 31K / month):
     pip install mkdocs-click
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mkdocs-click
mkdoxy - 🥈18 · ⭐ 30 · MIT ·
Automatically generates API documentation for your project based on Doxygen comments and code snippets in your..
  • GitHub (👨‍💻 7 · 🔀 11 · 📦 6 · 📋 37 - 2% open · ⏱️ 21.07.2023)
  • PyPi (📥 1.4K / month):
     pip install mkdoxy
    
  • Add to mkdocs.yml:
    plugins:
      - mkdoxy
MkApi - 🥈17 · ⭐ 81 · 💤 · MIT ·
A documentation generation tool for MkDocs.
  • GitHub (👨‍💻 4 · 🔀 17 · 📦 160 · 📋 49 - 57% open · ⏱️ 20.12.2020)
  • PyPi (📥 3.4K / month):
     pip install mkapi
    
  • Add to mkdocs.yml:
    plugins:
      - mkapi
MkDocsOAD - 🥈17 · ⭐ 79 · MIT · ·
Plugin for MkDocs to generate human readable documentation from OpenAPI Documentation Version 3 (also known as Swagger..
  • GitHub (👨‍💻 7 · 🔀 6 · 📥 430 · 📦 42 · 📋 26 - 34% open · ⏱️ 28.07.2023)
  • PyPi (📥 16K / month):
     pip install neoteroi-mkdocs
    
  • Add to mkdocs.yml:
    plugins:
      - neoteroi.mkdocsoad
      - neoteroi.contribs
    markdown_extensions:
      - neoteroi.cards
      - neoteroi.timeline
      - neoteroi.projects
      - neoteroi.spantable
automacdoc - 🥉7 · ⭐ 42 · 💤 · MIT
Automatic generation of documentation for mkdocs.
  • GitHub (👨‍💻 6 · 🔀 10 · 📦 4 · 📋 5 - 80% open · ⏱️ 29.12.2020)
Show 6 hidden projects...
MkAutoDoc - 🥉15 · ⭐ 200 · 📉 · ❗️BSD ·
Auto documentation for MkDocs.
  • GitHub (👨‍💻 7 · 🔀 14 · 📦 750 · 📋 18 - 38% open · ⏱️ 26.09.2022)
  • PyPi (📥 7.9K / month):
     pip install mkautodoc
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mkautodoc
mktheapidocs - 🥉12 · ⭐ 12 · 💤 · MIT ·
Numpydocs - mkdocs friendly markdown.
  • GitHub (👨‍💻 6 · 🔀 3 · 📦 36 · 📋 16 - 62% open · ⏱️ 10.06.2022)
  • PyPi (📥 470 / month):
     pip install mktheapidocs
    
  • Add to mkdocs.yml:
    plugins:
      - mktheapidocs
mkdocs-typer - 🥉11 · ⭐ 17 · 📈 · Apache-2 ·
An MkDocs extension to generate documentation for Typer command line applications.
  • GitHub (🔀 1 · 📋 4 - 50% open · ⏱️ 21.06.2023)
  • PyPi (📥 8.4K / month):
     pip install mkdocs-typer
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mkdocs-typer
doxygen - 🥉6 · ⭐ 14 · 💤 · MIT ·
A Doxygen plugin for MkDocs.
  • GitHub (👨‍💻 3 · 🔀 3 · ⏱️ 04.12.2020)
  • Add to mkdocs.yml:
    plugins:
      - doxygen
inari - 🥉6 · ⭐ 6 · 💤 · MIT ·
Write docstrings in markdown!.
  • GitHub (📦 4 · 📋 2 - 50% open · ⏱️ 10.07.2021)
  • PyPi (📥 140 / month):
     pip install inari
    
  • Add to mkdocs.yml:
    plugins:
      - inari
mkdocs-yaarg-plugin - 🥉2 · ⭐ 2 · 💤 · ❗Unlicensed ·
Yet Another API Reference Generator plugin for MKDocs.
  • GitHub (⏱️ 14.03.2021)
  • PyPi (📥 22 / month):
     pip install mkdocs-yaarg-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - yaarg

💬 Blogging

Back to top

rss - 🥇23 · ⭐ 50 · MIT ·
MkDocs plugin to generate a RSS feeds for created and updated pages, using git log and YAML frontmatter (page.meta).
  • GitHub (👨‍💻 10 · 🔀 14 · 📥 40 · 📦 270 · 📋 34 - 32% open · ⏱️ 05.09.2023)
  • PyPi (📥 16K / month):
     pip install mkdocs-rss-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - rss
mkdocs-blogging-plugin - 🥈19 · ⭐ 78 · MIT ·
Add blogging feature to your MkDocs site.
  • GitHub (👨‍💻 7 · 🔀 14 · 📥 11 · 📦 130 · 📋 38 - 10% open · ⏱️ 21.07.2023)
  • PyPi (📥 6.8K / month):
     pip install mkdocs-blogging-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - blogging
newsletter - 🥈10 · ⭐ 20 · ❗️GPL-3.0 ·
Automatically create newsletters from the changes in a mkdocs repository.
  • GitHub (👨‍💻 3 · 🔀 2 · 📦 28 · 📋 7 - 14% open · ⏱️ 04.08.2023)
  • PyPi (📥 470 / month):
     pip install mkdocs-newsletter
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-newsletter
Show 3 hidden projects...
Blogs for MkDocs - 🥉9 · ⭐ 13 · 💤 · MIT ·
This plugin for MkDocs allows to keeps a really simple blog section inside your documentation site.
  • GitHub (🔀 4 · 📦 80 · 📋 2 - 50% open · ⏱️ 13.04.2020)
  • Add to mkdocs.yml:
    plugins:
      - blog
blog - 🥉3 · ⭐ 15 · 💤 · ❗Unlicensed ·
Blogging in mkdocs.
python-mkblog - 🥉3 · ⭐ 1 · 💤 · 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 (📥 47 / month):
     pip install mkblog
    
  • Add to mkdocs.yml:
    plugins:
      - mkblog

📊 Charts, Images, Tables & Graphs

Back to top

mermaid2 - 🥇25 · ⭐ 180 · MIT ·
A Mermaid graphs plugin for mkdocs.
  • GitHub (👨‍💻 13 · 🔀 22 · 📦 1.5K · 📋 60 - 6% open · ⏱️ 01.09.2023)
  • PyPi (📥 120K / month):
     pip install mkdocs-mermaid2-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - mermaid2
table-reader - 🥇21 · ⭐ 89 · MIT ·
MkDocs plugin that enables a markdown tag like {{ read_csv(table.csv) }} to directly insert various table formats into..
  • GitHub (👨‍💻 6 · 🔀 12 · 📦 360 · 📋 37 - 8% open · ⏱️ 09.09.2023)
  • PyPi (📥 63K / month):
     pip install mkdocs-table-reader-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - table-reader
MkDocs GLightbox - 🥇19 · ⭐ 73 · MIT ·
A MkDocs plugin supports image lightbox (zoom effect) with GLightbox.
  • GitHub (👨‍💻 2 · 🔀 8 · 📥 24 · 📦 1.4K · 📋 21 - 19% open · ⏱️ 25.04.2023)
  • PyPi (📥 69K / month):
     pip install mkdocs-glightbox
    
  • Add to mkdocs.yml:
    plugins:
      - glightbox
drawio-exporter - 🥈18 · ⭐ 57 · MIT ·
Exports your Draw.io diagrams at build time for easier embedding into your documentation.
  • GitHub (👨‍💻 4 · 🔀 3 · 📦 55 · 📋 25 - 24% open · ⏱️ 07.06.2023)
  • PyPi (📥 8.7K / month):
     pip install mkdocs-drawio-exporter
    
  • Add to mkdocs.yml:
    plugins:
      - drawio-exporter
charts - 🥈17 · ⭐ 58 · MIT ·
Mkdocs plugin to add charts to your pages.
  • GitHub (👨‍💻 3 · 🔀 4 · 📦 35 · 📋 15 - 13% open · ⏱️ 31.08.2023)
  • PyPi (📥 3.7K / month):
     pip install mkdocs-charts-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - charts
MkDocs Video - 🥈17 · ⭐ 52 · MIT ·
MkDocs Video plugin.
  • GitHub (👨‍💻 5 · 🔀 11 · 📥 31 · 📦 470 · 📋 14 - 21% open · ⏱️ 17.03.2023)
  • PyPi (📥 35K / month):
     pip install mkdocs-video
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-video
kroki - 🥈17 · ⭐ 30 · MIT ·
MkDocs plugin for Kroki-Diagrams.
  • GitHub (👨‍💻 11 · 🔀 21 · 📦 24 · 📋 19 - 42% open · ⏱️ 31.03.2023)
  • PyPi (📥 12K / month):
     pip install mkdocs-kroki-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - kroki
Markdown blockdiag - 🥈16 · ⭐ 24 · 💤 · MIT ·
blockdiag extension for Python Markdown.
  • GitHub (👨‍💻 5 · 🔀 8 · 📦 98 · 📋 5 - 40% open · ⏱️ 14.12.2021)
  • PyPi (📥 2.9K / month):
     pip install markdown-blockdiag
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - markdown_blockdiag
build-plantuml - 🥈15 · ⭐ 44 · MIT ·
MkDocs plugin to help generate your plantuml images locally or remotely as files (NOT inline).
  • GitHub (👨‍💻 7 · 🔀 12 · 📦 88 · 📋 18 - 22% open · ⏱️ 04.12.2022)
  • PyPi (📥 24K / month):
     pip install mkdocs-build-plantuml-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - build_plantuml
Lightgallery - 🥉14 · ⭐ 24 · 💤 · MIT ·
Markdown extension to wrap images in a lightbox.
  • GitHub (👨‍💻 5 · 🔀 4 · 📦 83 · 📋 10 - 50% open · ⏱️ 15.02.2021)
  • PyPi (📥 2.6K / month):
     pip install lightgallery
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - lightgallery
markdownmermaid - 🥉12 · ⭐ 26 · 💤 · MIT ·
A MkDocs plugin that support mermaid graph in markdown file.
  • GitHub (👨‍💻 2 · 🔀 15 · 📦 73 · 📋 6 - 50% open · ⏱️ 26.05.2019)
  • PyPi (📥 6.5K / month):
     pip install mkdocs-mermaid-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - markdownmermaid
mkdocs-diagrams - 🥉10 · ⭐ 22 · 💤 · MIT ·
MkDocs plugin to render Diagrams files.
  • GitHub (🔀 1 · 📦 49 · 📋 2 - 50% open · ⏱️ 04.09.2020)
  • PyPi (📥 4.7K / month):
     pip install mkdocs-diagrams
    
  • Add to mkdocs.yml:
    plugins:
      - diagrams
Show 9 hidden projects...
docutools - 🥉9 · ⭐ 19 · BSD-2 ·
Dev Centric Tools for Mkdocs Based Documentation.
  • GitHub (👨‍💻 3 · 📦 6 · 📋 2 - 50% open · ⏱️ 04.09.2023)
  • PyPi (📥 140 / 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 - 🥉9 · ⭐ 18 · 💤 · MIT ·
A MkDocs plugin that converts markdown encoded images into figure elements.
  • GitHub (👨‍💻 2 · 🔀 7 · 📦 99 · 📋 3 - 66% open · ⏱️ 14.07.2020)
  • PyPi (📥 2K / month):
     pip install mkdocs-img2fig-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - img2fig
Termage - 🥉7 · ⭐ 14 · 💤 · MIT ·
Generate SVGs from any Python code, even in your documentation.
  • GitHub (📦 1 · 📋 5 - 20% open · ⏱️ 23.08.2022)
  • Add to mkdocs.yml:
    plugins:
      - termage
markdownwavedrom - 🥉6 · ⭐ 9 · 💤 · MPL-2.0 ·
A MkDocs plugin for support wavedrom charts in markdown file.
  • GitHub (🔀 2 · 📦 6 · 📋 3 - 33% open · ⏱️ 26.06.2021)
  • PyPi (📥 21 / month):
     pip install mkdocs-wavedrom-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - markdownwavedrom
plotly charts - 🥉6 · ⭐ 3 · MIT ·
Mkdocs plugin to add interactive charts with Plotly.js.
  • GitHub (👨‍💻 2 · 🔀 1 · 📦 4 · ⏱️ 25.07.2023)
  • PyPi (📥 540 / month):
     pip install mkdocs-plotly-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - plotly
markdown-figcap - 🥉5 · ⭐ 1 · 💤 · BSD-3 ·
Extension for Python-Markdown to handle figure and figcaption.
  • GitHub (📦 3 · ⏱️ 09.03.2019)
  • PyPi (📥 78 / month):
     pip install markdown-figcap
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - markdown_figcap
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 (⏱️ 06.02.2023)
  • PyPi (📥 79 / 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 - 🥇28 · ⭐ 230 · MIT ·
Create richer and more beautiful pages in MkDocs, by using variables and calls to macros in the markdown code.
  • GitHub (👨‍💻 26 · 🔀 38 · 📦 2.3K · 📋 100 - 4% open · ⏱️ 14.08.2023)
  • PyPi (📥 200K / month):
     pip install mkdocs-macros-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - macros
mkdocs-jupyter - 🥇23 · ⭐ 280 · Apache-2 ·
Use Jupyter Notebook in mkdocs.
  • GitHub (👨‍💻 19 · 🔀 36 · 📦 1.5K · 📋 97 - 25% open · ⏱️ 17.09.2023)
  • PyPi (📥 86K / month):
     pip install mkdocs-jupyter
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-jupyter
mknotebooks - 🥇23 · ⭐ 120 · MIT ·
A plugin for mkdocs to help you include Jupyter notebooks in your projects.
  • GitHub (👨‍💻 14 · 🔀 19 · 📦 420 · 📋 38 - 31% open · ⏱️ 11.08.2023)
  • PyPi (📥 22K / month):
     pip install mknotebooks
    
  • Add to mkdocs.yml:
    plugins:
      - mknotebooks
gen-files - 🥈21 · ⭐ 63 · 📈 · MIT ·
MkDocs plugin to programmatically generate documentation pages during the build.
  • GitHub (👨‍💻 5 · 🔀 7 · 📦 1.5K · 📋 21 - 19% open · ⏱️ 18.09.2023)
  • PyPi (📥 120K / month):
     pip install mkdocs-gen-files
    
  • Add to mkdocs.yml:
    plugins:
      - gen-files
markdownextradata - 🥈20 · ⭐ 68 · 💤 · MIT ·
A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template.
  • GitHub (👨‍💻 10 · 🔀 16 · 📦 880 · 📋 32 - 18% open · ⏱️ 15.12.2021)
  • PyPi (📥 29K / month):
     pip install mkdocs-markdownextradata-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - markdownextradata
mkdocs-markmap - 🥈17 · ⭐ 32 · MIT ·
MkDocs plugin and extension to create mindmaps from markdown using markmap.
  • GitHub (👨‍💻 3 · 🔀 5 · 📥 160 · 📋 24 - 25% open · ⏱️ 06.09.2023)
  • PyPi (📥 1.2K / month):
     pip install mkdocs-markmap
    
  • Add to mkdocs.yml:
    plugins:
      - markmap
Termynal - 🥈15 · ⭐ 46 · MIT ·
Python markdown terminal. Built for mkdocs.
  • GitHub (👨‍💻 4 · 🔀 6 · 📦 87 · 📋 9 - 44% open · ⏱️ 21.08.2023)
  • PyPi (📥 1.7K / month):
     pip install termynal
    
  • Add to mkdocs.yml:
    plugins:
      - termynal
markdown-exec - 🥉13 · ⭐ 52 · ISC ·
Utilities to execute code blocks in Markdown files.
  • GitHub (👨‍💻 2 · 🔀 4 · 📦 83 · 📋 23 - 39% open · ⏱️ 14.06.2023)
  • PyPi (📥 8.4K / month):
     pip install markdown-exec
    
  • Add to mkdocs.yml:
    plugins:
      - markdown-exec
codeyaml - 🥉5 · 💤 · MIT ·
Allows for more than one yaml config in mkdocs.
  • GitHub (🔀 1 · ⏱️ 30.04.2019)
  • PyPi (📥 15 / month):
     pip install mkdocs-codeyaml-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - codeyaml
Entangled - 🥉5 · 🐣 · Apache-2 ·
An MkDocs plugin that lets you do Literate Programming through Entangled.
  • GitHub (📦 2 · ⏱️ 29.05.2023)
  • PyPi (📥 98 / month):
     pip install mkdocs-entangled-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - entangled
Show 8 hidden projects...
user-defined-values - 🥉12 · ⭐ 4 · 💤 · MIT ·
MkDocs User Defined Values.
  • GitHub (👨‍💻 3 · 🔀 3 · 📥 10 · 📦 11 · ⏱️ 10.07.2022)
  • PyPi (📥 740 / month):
     pip install mkdocs-user-defined-values
    
  • Add to mkdocs.yml:
    plugins:
      - user-defined-values
pheasant - 🥉11 · ⭐ 16 · 💤 · MIT ·
Documentation tool for Markdown conversion by Jupyter client.
  • GitHub (👨‍💻 4 · 🔀 9 · 📦 38 · 📋 11 - 54% open · ⏱️ 19.12.2020)
  • PyPi (📥 140 / month):
     pip install pheasant
    
  • Add to mkdocs.yml:
    plugins:
      - pheasant
mkjsfiddle - 🥉8 · ⭐ 4 · MIT ·
An MkDocs plugin that lets you edit code fences in JSFiddle.
  • GitHub (⏱️ 07.06.2023)
  • PyPi (📥 67 / month):
     pip install mkjsfiddle
    
  • Add to mkdocs.yml:
    plugins:
      - jsfiddle
markdown-filter - 🥉7 · ⭐ 2 · 💤 · MIT ·
Adds a markdown template filter to the jinja templating environment in mkdocs.
  • GitHub (📦 16 · ⏱️ 06.02.2019)
  • PyPi (📥 300 / month):
     pip install mkdocs-markdown-filter
    
  • Add to mkdocs.yml:
    plugins:
      - markdown-filter
meta-manager - 🥉7 · ⭐ 1 · MIT ·
MkDocs plugin for managing meta tags across folders and files.
  • GitHub (👨‍💻 3 · 🔀 1 · 📦 1 · ⏱️ 24.03.2023)
  • PyPi (📥 540 / month):
     pip install mkdocs-meta-manager
    
  • Add to mkdocs.yml:
    plugins:
      - meta-manager
nbconvert - 🥉6 · ⭐ 6 · BSD-2 ·
A MkDocs plug-in provides a source parser for *.ipynb files.
  • GitHub (👨‍💻 5 · 🔀 1 · 📦 2 · ⏱️ 29.06.2023)
  • PyPi (📥 45 / month):
     pip install mkdocs-nbconvert
    
  • Add to mkdocs.yml:
    plugins:
      - nbconvert
jinja2sandbox - 🥉5 · ⭐ 3 · 💤 · MIT ·
A MkDocs plugin that enables the Jinja2-sandbox.
mkdocs_protobuf - 🥉4 · ⭐ 2 · 💤 · Apache-2 ·
Mkdocs plugin to render protobuf messages.
  • GitHub (👨‍💻 2 · 🔀 1 · ⏱️ 30.03.2022)
  • PyPi (📥 160 / month):
     pip install mkdocs_protobuf
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs_protobuf

🌲 Git repos & info

Back to top

git-revision-date-localized - 🥇25 · ⭐ 130 · MIT ·
MkDocs plugin to add a last updated date to your site pages.
  • GitHub (👨‍💻 21 · 🔀 29 · 📦 4.6K · 📋 76 - 11% open · ⏱️ 02.03.2023)
  • PyPi (📥 180K / month):
     pip install mkdocs-git-revision-date-localized-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - git-revision-date-localized
git-authors - 🥈21 · ⭐ 52 · MIT ·
MkDocs plugin to display git authors of a page.
  • GitHub (👨‍💻 7 · 🔀 14 · 📦 480 · 📋 50 - 18% open · ⏱️ 04.07.2023)
  • PyPi (📥 42K / month):
     pip install mkdocs-git-authors-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - git-authors
git-committers-2 - 🥈20 · ⭐ 21 · MIT ·
An MkDocs plugin to create a list of contributors on the page.
  • GitHub (👨‍💻 7 · 🔀 11 · 📦 260 · 📋 20 - 45% open · ⏱️ 06.09.2023)
  • PyPi (📥 9.4K / month):
     pip install mkdocs-git-committers-plugin-2
    
  • Add to mkdocs.yml:
    plugins:
      - git-committers
git-revision-date - 🥉19 · ⭐ 54 · 💤 · MIT ·
MkDocs plugin for setting revision date from git per markdown file.
  • GitHub (👨‍💻 7 · 🔀 9 · 📦 1.6K · 📋 13 - 30% open · ⏱️ 08.03.2022)
  • PyPi (📥 38K / month):
     pip install mkdocs-git-revision-date-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - git-revision-date
git-committers - 🥉14 · ⭐ 26 · 💤 · MIT ·
A mkdocs plugin for displaying the last commit and a list of a files contributors.
  • GitHub (👨‍💻 5 · 🔀 6 · 📦 140 · ⏱️ 12.08.2021)
  • PyPi (📥 4.8K / month):
     pip install mkdocs-git-committers-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - git-committers
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 (📥 450 / month):
     pip install mkdocs-latest-release-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - git-latest-release
Show 2 hidden projects...
Github-Links - 🥉12 · ⭐ 6 · ❗Unlicensed ·
Python-Markdown GitHub Links Extension.
  • GitHub (👨‍💻 3 · 🔀 8 · 📦 100 · ⏱️ 31.07.2023)
  • PyPi (📥 5.2K / 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 (📦 14 · ⏱️ 17.04.2022)
  • PyPi (📥 400 / month):
     pip install mkdocs-branchcustomization-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - branchcustomization

🌈 HTML processing & CSS styling

Back to top

minify - 🥇23 · ⭐ 100 · MIT ·
A mkdocs plugin to minify the HTML of a page before it is written to disk.
  • GitHub (👨‍💻 10 · 🔀 13 · 📦 6K · 📋 14 - 14% open · ⏱️ 01.08.2023)
  • PyPi (📥 140K / month):
     pip install mkdocs-minify-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - minify
enumerate-headings - 🥈18 · ⭐ 34 · MIT ·
MkDocs Plugin to enumerate the headings across site pages.
  • GitHub (👨‍💻 4 · 🔀 4 · 📦 140 · 📋 28 - 3% open · ⏱️ 27.05.2023)
  • PyPi (📥 7.2K / month):
     pip install mkdocs-enumerate-headings-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - enumerate-headings
Show 7 hidden projects...
minify-html - 🥈12 · ⭐ 1 · 🐣 · MIT ·
MkDocs plugin for minification using minify-html, an extremely fast HTML + JS + CSS minifier.
  • GitHub (👨‍💻 2 · 📦 10 · ⏱️ 19.09.2023)
  • PyPi (📥 1.1K / month):
     pip install mkdocs-minify-html-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - minify_html
add-number - 🥈10 · ⭐ 11 · 💤 · MIT ·
MkDocs plugin to automatically number the headings (h1-h6) in each markdown page and the nav.
  • GitHub (👨‍💻 3 · 🔀 3 · 📦 29 · 📋 11 - 18% open · ⏱️ 11.06.2020)
  • PyPi (📥 930 / month):
     pip install mkdocs-add-number-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - add-number
mkdocs_safe_text - 🥈10 · ⭐ 3 · BSD-2 ·
Plugin for safe text editing with MKDocs.
  • GitHub (👨‍💻 2 · ⏱️ 03.08.2023)
  • PyPi (📥 330 / month):
     pip install mkdocs-safe-text-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs_safe_text
bootstrap-tables - 🥉9 · ⭐ 11 · 💤 · MIT ·
A MkDocs plugin to add bootstrap classes to plan markdown generated tables.
  • GitHub (🔀 2 · 📦 66 · ⏱️ 27.03.2020)
  • PyPi (📥 1.2K / month):
     pip install mkdocs-bootstrap-tables-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - bootstrap-tables
mkdocs-add-teaser - 🥉8 · ⭐ 5 · MIT ·
An MkDocs plugin to customize the first paragraph of your pages, and to use it as the pages meta description.
  • GitHub (🔀 1 · 📦 1 · ⏱️ 08.11.2022)
  • PyPi (📥 160 / month):
     pip install mkdocs-add-teaser
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-add-teaser
toggle-sidebar - 🥉6 · ⭐ 1 · MIT ·
Toggle the navigation and/or TOC sidebars on your MkDocs site.
  • GitHub (⏱️ 21.09.2023)
  • PyPi (📥 280 / month):
     pip install mkdocs-toggle-sidebar-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - toggle-sidebar
docstyler - 🥉3 · 💤 · BSD-3 ·
Plugin to add alternative stylesheets to MkDocs custom themes.

📎 Integrations with other tools

Back to top

MkDocs Swagger UI Tag - 🥇17 · ⭐ 42 · MIT ·
A MkDocs plugin supports for add Swagger UI in page.
  • GitHub (👨‍💻 2 · 🔀 5 · 📥 26 · 📦 71 · 📋 12 - 25% open · ⏱️ 14.09.2023)
  • PyPi (📥 12K / month):
     pip install mkdocs-swagger-ui-tag
    
  • Add to mkdocs.yml:
    plugins:
      - swagger-ui-tag
mkdocs-render-swagger-plugin - 🥈13 · ⭐ 54 · MIT ·
A plugin for MKDocs for rendering swagger & openapi schemas using SwaggerUI.
  • GitHub (👨‍💻 6 · 🔀 9 · 📦 130 · 📋 13 - 53% open · ⏱️ 22.03.2023)
  • Add to mkdocs.yml:
    plugins:
      - render_swagger
swagger - 🥉6 · ⭐ 29 · 💤 · MIT ·
MkDocs plugin for render swagger into docs.
  • GitHub (🔀 6 · 📋 5 - 60% open · ⏱️ 06.10.2019)
  • Add to mkdocs.yml:
    plugins:
      - swagger
Show 3 hidden projects...
mkdocs-coverage - 🥈16 · ⭐ 6 · ISC ·
MkDocs plugin to integrate your coverage HTML report into your site.
  • GitHub (🔀 1 · 📦 170 · 📋 7 - 57% open · ⏱️ 02.08.2023)
  • PyPi (📥 21K / 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 · 📦 27 · ⏱️ 12.12.2022)
  • PyPi (📥 170 / month):
     pip install foliantcontrib.mkdocs
    
factsheet - 🥉5 · ⭐ 2 · 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

🌍 Internationalization & localization

Back to top

static-i18n - 🥇23 · ⭐ 160 · MIT ·
MkDocs i18n plugin using static translation markdown files.
  • GitHub (👨‍💻 8 · 🔀 28 · 📦 720 · 📋 110 - 7% open · ⏱️ 21.09.2023)
  • PyPi (📥 28K / month):
     pip install mkdocs-static-i18n
    
  • Add to mkdocs.yml:
    plugins:
      - i18n
Show 1 hidden projects...
mkdocs-mdpo - 🥉11 · ⭐ 4 · BSD-3 ·
Mkdocs translation plugin using PO files.
  • GitHub (👨‍💻 3 · 🔀 3 · 📥 150 · 📋 36 - 33% open · ⏱️ 03.01.2023)
  • PyPi (📥 200 / month):
     pip install mkdocs-mdpo-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - mdpo

🔗 Links & references

Back to top

mkdocs-redirects - 🥇23 · ⭐ 120 · 📈 · MIT ·
Open source plugin for Mkdocs page redirects.
  • GitHub (👨‍💻 13 · 🔀 16 · 📦 2.4K · 📋 29 - 37% open · ⏱️ 16.09.2023)
  • PyPi (📥 110K / month):
     pip install mkdocs-redirects
    
  • Add to mkdocs.yml:
    plugins:
      - redirects
autorefs - 🥇23 · ⭐ 26 · 📉 · ISC ·
Automatically link across pages in MkDocs.
  • GitHub (👨‍💻 6 · 🔀 3 · 📦 4.1K · 📋 11 - 45% open · ⏱️ 02.08.2023)
  • PyPi (📥 600K / month):
     pip install mkdocs-autorefs
    
  • Add to mkdocs.yml:
    plugins:
      - autorefs
htmlproofer - 🥈21 · ⭐ 35 · MIT ·
A MkDocs plugin that validates URL in rendered html files.
  • GitHub (👨‍💻 12 · 🔀 11 · 📦 290 · 📋 27 - 11% open · ⏱️ 18.08.2023)
  • PyPi (📥 31K / month):
     pip install mkdocs-htmlproofer-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - htmlproofer
autolinks - 🥈18 · ⭐ 67 · MIT ·
An MkDocs plugin that automagically generates relative links between markdown pages.
  • GitHub (👨‍💻 10 · 🔀 14 · 📦 320 · 📋 16 - 43% open · ⏱️ 04.08.2023)
  • PyPi (📥 45K / month):
     pip install mkdocs-autolinks-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - autolinks
ezlinks - 🥈14 · ⭐ 30 · 💤 · MIT ·
Plugin for mkdocs which enables easier linking between pages.
  • GitHub (🔀 11 · 📥 110 · 📦 74 · 📋 22 - 36% open · ⏱️ 24.01.2022)
  • PyPi (📥 3K / month):
     pip install mkdocs-ezlinks-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - ezlinks
roamlinks - 🥈11 · ⭐ 40 · MIT ·
An MkDocs plugin that automagically generates relative links between markdown pages.
  • GitHub (👨‍💻 9 · 🔀 13 · ⏱️ 08.06.2023)
  • PyPi (📥 5.4K / month):
     pip install mkdocs-roamlinks-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - roamlinks
webcontext - 🥉6 · MIT ·
Mkdocs plugin for converting absolute paths to webcontext aware paths using the configured webcontext context.
  • GitHub (👨‍💻 2 · 🔀 1 · 📥 5 · 📦 4 · ⏱️ 25.05.2023)
  • PyPi (📥 110 / month):
     pip install mkdocs-webcontext-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - webcontext
Show 13 hidden projects...
mkdocs-open-in-new-tab - 🥈11 · ⭐ 9 · 🐣 · MIT ·
This plugin adds JS to open outgoing links and PDFs in a new tab.
  • GitHub (🔀 1 · 📦 47 · ⏱️ 24.05.2023)
  • PyPi (📥 2.2K / month):
     pip install mkdocs-open-in-new-tab
    
  • Add to mkdocs.yml:
    plugins:
      - open-in-new-tab
unused-files - 🥈11 · ⭐ 6 · MIT ·
An MkDocs plugin to find unused (orphaned) files in your project.
  • GitHub (👨‍💻 2 · 🔀 1 · 📦 6 · ⏱️ 17.07.2023)
  • PyPi (📥 1.8K / month):
     pip install mkdocs-unused-files
    
  • Add to mkdocs.yml:
    plugins:
      - unused_files
mkdocs-alias-plugin - 🥉10 · ⭐ 8 · MIT ·
An MkDocs plugin allowing links to your pages using a custom alias.
  • GitHub (👨‍💻 2 · 🔀 1 · 📦 7 · 📋 4 - 25% open · ⏱️ 23.06.2023)
  • PyPi (📥 270 / month):
     pip install mkdocs-alias-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - alias
mkdocs-site-urls - 🥉9 · ⭐ 5 · 🐣 · MIT ·
A MkDocs plugin that adds support for site-relative `site:` URLs.
  • GitHub (🔀 1 · 📦 2 · ⏱️ 31.07.2023)
  • PyPi (📥 3.4K / month):
     pip install mkdocs-site-urls
    
  • Add to mkdocs.yml:
    plugins:
      - site-urls
abs-to-rel - 🥉9 · ⭐ 3 · 💤 · MIT ·
MkDocs plugin for converting absolute links to relative ones.
  • GitHub (👨‍💻 2 · 🔀 3 · 📦 19 · ⏱️ 03.03.2020)
  • PyPi (📥 1.1K / month):
     pip install mkdocs-abs-rel-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - abs-to-rel
Autolink References - 🥉8 · ⭐ 14 · 💤 · MIT ·
Provides GitHub like autolink references in Mkdocs.
  • GitHub (👨‍💻 2 · 🔀 4 · 📦 5 · 📋 4 - 75% open · ⏱️ 26.01.2022)
  • PyPi (📥 4.9K / month):
     pip install autolink-references-mkdocs-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - autolink_references
tooltipster-links - 🥉8 · ⭐ 6 · 💤 · MIT ·
An MkDocs plugin that adds tooltips to preview the content of page links using tooltipster.
  • GitHub (🔀 1 · 📦 20 · ⏱️ 29.07.2020)
  • PyPi (📥 110 / month):
     pip install mkdocs-tooltipster-links-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - tooltipster-links
link-marker - 🥉8 · ⭐ 3 · MIT ·
MkDocs plugin for marking links e.g. external ones or mails.
  • GitHub (⏱️ 07.02.2023)
  • PyPi (📥 560 / month):
     pip install mkdocs-link-marker
    
  • Add to mkdocs.yml:
    plugins:
      - link-marker
ezglossary - 🥉8 · ⭐ 1 · 🐣 · MIT ·
Glossary support for mkdocs.
  • GitHub (📋 2 - 50% open · ⏱️ 15.09.2023)
  • PyPi (📥 1.6K / month):
     pip install mkdocs-ezglossary-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - ezglossary
Wikilink Plus - 🥉7 · ⭐ 14 · 💤 · ❗Unlicensed ·
A wikilink extension for Python Markdown.
  • GitHub (👨‍💻 5 · 🔀 2 · ⏱️ 26.07.2022)
  • PyPi (📥 2.1K / month):
     pip install mdx_wikilink_plus
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mdx_wikilink_plus
autoreflinks - 🥉3 · ⭐ 5 · 💤 · ❗️0BSD ·
An MkDocs plugin that auto-links heading references.
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
emailprotect - 🥉3 · ⭐ 2 · 💤 · MIT ·
A MkDocs plugin that tries to obscure email-addresses from address-harvesting spam-bots.

🧩 Markdown extensions

Back to top

PyMdown Extensions - 🥇31 · ⭐ 800 · ❗Unlicensed ·
Extensions for Python Markdown.
  • GitHub (👨‍💻 43 · 🔀 240 · 📦 24K · 📋 340 - 2% open · ⏱️ 20.09.2023)
  • PyPi (📥 2.1M / month):
     pip install pymdown-extensions
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - pymdownx.arithmatex
      - pymdownx.b64
      - pymdownx.betterem
      - 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
Mdx Truly Sane Lists - 🥈15 · ⭐ 64 · 💤 · MIT ·
Extension for Python-Markdown that makes lists truly sane. Custom indents for nested lists and fix for messy..
  • GitHub (👨‍💻 4 · 🔀 9 · 📋 14 - 50% open · ⏱️ 19.07.2022)
  • PyPi (📥 170K / month):
     pip install mdx_truly_sane_lists
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mdx_truly_sane_lists
Math extension - 🥈14 · ⭐ 110 · 💤 · BSD-3 ·
Math extension for Python-Markdown.
  • GitHub (👨‍💻 8 · 🔀 25 · 📋 24 - 8% open · ⏱️ 12.08.2022)
  • PyPi (📥 37K / month):
     pip install python-markdown-math
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mdx_math
Show 9 hidden projects...
markdown-callouts - 🥇16 · ⭐ 19 · MIT ·
Markdown extension: a classier syntax for admonitions.
  • GitHub (🔀 13 · 📦 110 · 📋 11 - 45% open · ⏱️ 10.09.2023)
  • PyPi (📥 8.6K / month):
     pip install markdown-callouts
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - callouts
YAML metadata - 🥈14 · ⭐ 19 · MIT ·
YAML metadata extension for Python-Markdown.
  • GitHub (👨‍💻 7 · 🔀 4 · 📦 71 · 📋 10 - 30% open · ⏱️ 09.09.2023)
  • PyPi (📥 660 / month):
     pip install markdown-full-yaml-metadata
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - full_yaml_metadata
mkdocs-callouts - 🥈14 · ⭐ 13 · MIT ·
A simple MkDocs plugin that converts Obsidian callout blocks to mkdocs supported Admonitions.
  • GitHub (👨‍💻 2 · 🔀 1 · 📦 700 · ⏱️ 12.09.2023)
  • PyPi (📥 4.8K / month):
     pip install mkdocs-callouts
    
  • Add to mkdocs.yml:
    plugins:
      - callouts
Markdown Inline Graphviz - 🥈14 · ⭐ 3 · MIT ·
Render inline graphs with Markdown and Graphviz.
  • GitHub (👨‍💻 8 · 🔀 7 · ⏱️ 01.05.2023)
  • PyPi (📥 120K / month):
     pip install markdown_inline_graphviz_extension
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - markdown_inline_graphviz
Breakless Lists - 🥉8 · ⭐ 5 · 💤 · MIT ·
Python markdown breakless lists extension.
  • GitHub (🔀 2 · 📋 2 - 50% open · ⏱️ 08.10.2020)
  • PyPi (📥 3.6K / month):
     pip install mdx-breakless-lists
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mdx_breakless_lists
mkpatcher - 🥉8 · ⭐ 2 · 💤 · Apache-2 ·
Python-Markdown extension allowing arbitrary scripts to modify MkDocs input files.
  • GitHub (📦 3 · ⏱️ 26.04.2020)
  • PyPi (📥 1.1K / 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 (📦 2 · ⏱️ 25.03.2019)
  • PyPi (📥 21 / 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 (📥 190 / month):
     pip install hbfm
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - hbfm.inline_coloring
      - hbfm.inline_list
      - hbfm.number_headers
      - hbfm.quote_uri_hash
markdown-del-ins - 🥉3 · ⭐ 11 · 💤 · ❗Unlicensed ·
Markdown extension to support the del and ins tags.
  • GitHub (👨‍💻 2 · ⏱️ 09.01.2020)
  • PyPi (📥 490 / month):
     pip install markdown-del-ins
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - markdown_del_ins

🧭 Navigation & page building

Back to top

awesome-pages - 🥇25 · ⭐ 360 · MIT ·
An MkDocs plugin that simplifies configuring page titles and their order.
  • GitHub (👨‍💻 7 · 🔀 29 · 📦 3.2K · 📋 68 - 19% open · ⏱️ 19.08.2023)
  • PyPi (📥 150K / month):
     pip install mkdocs-awesome-pages-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - awesome-pages
encryptcontent - 🥇23 · ⭐ 84 · MIT ·
A MkDocs plugin that encrypt/decrypt markdown content with AES.
  • GitHub (👨‍💻 4 · 🔀 12 · 📥 79 · 📦 710 · 📋 46 - 6% open · ⏱️ 19.09.2023)
  • PyPi (📥 5.8K / month):
     pip install mkdocs-encryptcontent-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - encryptcontent
section-index - 🥇21 · ⭐ 62 · 📉 · MIT ·
MkDocs plugin to allow clickable sections that lead to an index page.
  • GitHub (👨‍💻 2 · 🔀 6 · 📦 1.2K · 📋 17 - 29% open · ⏱️ 18.09.2023)
  • PyPi (📥 130K / month):
     pip install mkdocs-section-index
    
  • Add to mkdocs.yml:
    plugins:
      - section-index
literate-nav - 🥇21 · ⭐ 55 · MIT ·
MkDocs plugin to specify the navigation in Markdown instead of YAML.
  • GitHub (🔀 8 · 📦 1.2K · 📋 22 - 40% open · ⏱️ 18.09.2023)
  • PyPi (📥 110K / month):
     pip install mkdocs-literate-nav
    
  • Add to mkdocs.yml:
    plugins:
      - literate-nav
mkdocs-simple-hooks - 🥈18 · ⭐ 51 · 📉 · MIT ·
Define your own hooks for mkdocs, without having to create a new package.
  • GitHub (👨‍💻 5 · 🔀 4 · 📥 30 · 📦 1.1K · ⏱️ 12.09.2023)
  • PyPi (📥 22K / month):
     pip install mkdocs-simple-hooks
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-simple-hooks
exclude - 🥈17 · ⭐ 78 · 💤 · Apache-2 ·
A mkdocs plugin that lets you exclude files or trees from your output.
  • GitHub (🔀 9 · 📦 1.5K · 📋 12 - 75% open · ⏱️ 20.02.2019)
  • PyPi (📥 100K / month):
     pip install mkdocs-exclude
    
  • Add to mkdocs.yml:
    plugins:
      - exclude
mkdocs-gallery - 🥈16 · ⭐ 21 · BSD-3 ·
Same features as sphinx-gallery (https://sphinx-gallery.github.io/) but on mkdocs (https://www.mkdocs.org/) (no sphinx..
  • GitHub (👨‍💻 5 · 🔀 6 · 📋 54 - 44% open · ⏱️ 15.05.2023)
  • PyPi (📥 1.2K / month):
     pip install mkdocs-gallery
    
  • Add to mkdocs.yml:
    plugins:
      - gallery
MkRefs - 🥉9 · ⭐ 24 · MIT ·
MkDocs plugin to generate semantic reference Markdown pages from a knowledge graph.
  • GitHub (👨‍💻 2 · 📦 2 · ⏱️ 31.08.2023)
  • PyPi (📥 50 / month):
     pip install mkrefs
    
  • Add to mkdocs.yml:
    plugins:
      - mkrefs
SWAN Gallery - 🥉8 · ❗️AGPL-3.0 ·
MkDocs plugin to generate a SWAN Gallery.
  • GitHub (👨‍💻 2 · 📦 1 · ⏱️ 20.07.2023)
  • PyPi (📥 29 / month):
     pip install mkdocs-swangallery
    
  • Add to mkdocs.yml:
    plugins:
      - swangallery
select-files - 🥉6 · 💤 · Apache-2 ·
Filter pages for assignments.
  • GitHub (📦 7 · ⏱️ 05.09.2019)
  • PyPi (📥 21 / month):
     pip install mkdocs-select-files
    
  • Add to mkdocs.yml:
    plugins:
      - select-files
Show 13 hidden projects...
file-filter - 🥈13 · ⭐ 6 · MIT ·
A MkDocs plugin that lets you exclude/include docs files using globs, regexes, gitignore-style file and..
  • GitHub (👨‍💻 4 · 🔀 2 · 📥 29 · 📦 2 · 📋 9 - 33% open · ⏱️ 05.09.2023)
  • PyPi (📥 3.5K / month):
     pip install mkdocs-file-filter-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - file-filter
mkdocs-categories-plugin - 🥈10 · ⭐ 10 · MIT ·
An MkDocs plugin allowing for categorization of wiki pages.
  • GitHub (📦 11 · ⏱️ 23.06.2023)
  • PyPi (📥 160 / month):
     pip install mkdocs-categories-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - categories
mkdocs-nav-weight - 🥉9 · ⭐ 3 · MIT ·
A simple mkdocs plugin, enables to organize Navigation in a more markdownic way.
  • GitHub (👨‍💻 2 · 🔀 1 · 📦 2 · ⏱️ 13.09.2023)
  • PyPi (📥 920 / month):
     pip install mkdocs-nav-weight
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-nav-weight
mkdocs-nav-enhancements - 🥉8 · ⭐ 2 · 💤 · MIT ·
WIP plugin for working with titles of pages in MkDocs.
  • GitHub (📦 32 · ⏱️ 24.07.2019)
  • PyPi (📥 4.3K / month):
     pip install mkdocs-nav-enhancements
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-nav-enhancements
toc-sidebar - 🥉8 · ⭐ 2 · 💤 · MIT ·
An MkDocs plugin that allows users to add additional content to the ToC sidebar using the Material theme.
  • GitHub (👨‍💻 2 · 🔀 3 · 📦 22 · ⏱️ 11.01.2020)
  • PyPi (📥 330 / month):
     pip install mkdocs-toc-sidebar-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - toc-sidebar
mkdocs-live-edit-plugin - 🥉7 · ⭐ 5 · 🐣 · MIT ·
An MkDocs plugin that allows editing pages directly from the browser.
  • GitHub (📦 2 · ⏱️ 23.06.2023)
  • PyPi (📥 100 / month):
     pip install mkdocs-live-edit-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - live-edit
schema-reader - 🥉6 · ⭐ 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 (📥 390 / month):
     pip install mkdocs-schema-reader
    
  • Add to mkdocs.yml:
    plugins:
      - schema_reader
awesome-list - 🥉4 · ⭐ 4 · 💤 · MIT ·
MkDocs Plugin to inject social media cards for each entry in an awesome-list.
mkdocs-copy - 🥉4 · ⭐ 3 · 💤 · 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 - 🥉3 · ⭐ 1 · ❗️GPL-3.0 ·
A lightweight mkdocs plugin to add title casing to all mkdocs pages and sections.
  • GitHub (⏱️ 02.09.2023)
  • PyPi (📥 100 / 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
filename-title - 🥉1 · ⭐ 1 · 💤 · ❗️AGPL-3.0 ·
A mkdocs plugin which lets you use filenames as page tiltles.
  • GitHub (🔀 1 · ⏱️ 25.04.2020)
  • Add to mkdocs.yml:
    plugins:
      - filename_title
mkdocs-pug - 🥉1 · 💤 · ❗Unlicensed
Use pug templates with your mkdocs template.
  • GitHub (⏱️ 20.10.2021)
  • PyPi (📥 9 / month):
     pip install mkdocs-pug
    

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

Back to top

mktestdocs - 🥇16 · ⭐ 94 · Apache-2
Run pytest against markdown files/docstrings.
  • GitHub (👨‍💻 3 · 🔀 5 · 📦 32 · 📋 3 - 66% open · ⏱️ 27.04.2023)
  • PyPi (📥 9.2K / month):
     pip install mktestdocs
    
Show 4 hidden projects...
mkdocs-spellcheck - 🥈15 · ⭐ 8 · ISC ·
A spell checker plugin for MkDocs.
  • GitHub (👨‍💻 3 · 🔀 2 · 📦 29 · 📋 15 - 46% open · ⏱️ 05.09.2023)
  • PyPi (📥 5.3K / month):
     pip install mkdocs-spellcheck
    
  • Add to mkdocs.yml:
    plugins:
      - spellcheck
Link Checker - 🥉10 · ⭐ 6 · 💤 · MIT
Python asyncio + aiohttp Markdown *.md URL link checker: 10,000 files/second.
  • GitHub (👨‍💻 5 · 🔀 4 · ⏱️ 24.08.2021)
  • PyPi (📥 1.4K / month):
     pip install mkdocs-linkcheck
    
mkdocs-code-validator - 🥉9 · ⭐ 1 · MIT ·
Checks Markdown code blocks in a MkDocs site against user-defined actions.
  • GitHub (📦 11 · ⏱️ 18.09.2023)
  • PyPi (📥 260 / month):
     pip install mkdocs-code-validator
    
  • Add to mkdocs.yml:
    plugins:
      - code-validator
mkdocs-codecheck - 🥉6 · ⭐ 1 · 💤 · MIT
Traverses a directory tree looking for code samples, then attempts to validate each code sample found.
  • GitHub (👨‍💻 6 · ⏱️ 16.12.2021)
  • PyPi (📥 29 / month):
     pip install mkdocs-codecheck
    

🔍 Search & tables of content

Back to top

exclude-search - 🥇19 · ⭐ 25 · MIT ·
A mkdocs plugin that lets you exclude selected chapters from the search index.
  • GitHub (👨‍💻 4 · 🔀 3 · 📥 8 · 📦 280 · ⏱️ 04.02.2023)
  • PyPi (📥 11K / 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 (👨‍💻 4 · 🔀 7 · 📦 59 · ⏱️ 02.01.2023)
  • PyPi (📥 2.5K / month):
     pip install mkdocs-localsearch
    
  • Add to mkdocs.yml:
    plugins:
      - localsearch
tags - 🥉9 · ⭐ 42 · 💤 · MIT ·
Processes tags in yaml metadata.
  • GitHub (👨‍💻 3 · 🔀 19 · 📋 14 - 50% open · ⏱️ 02.09.2021)
  • PyPi (📥 480 / month):
     pip install mkdocs-plugin-tags
    
  • Add to mkdocs.yml:
    plugins:
      - tags

🍱 Site conversion (PDF/ePUB/etc.)

Back to top

pdf-export - 🥇22 · ⭐ 290 · 💤 · MIT ·
An MkDocs plugin to export content pages as PDF files.
  • GitHub (👨‍💻 11 · 🔀 42 · 📦 500 · 📋 87 - 47% open · ⏱️ 05.10.2021)
  • PyPi (📥 18K / month):
     pip install mkdocs-pdf-export-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - pdf-export
mkdocs-with-pdf - 🥇22 · ⭐ 260 · 💤 · MIT ·
Generate a single PDF file from MkDocs repository.
  • GitHub (👨‍💻 6 · 🔀 66 · 📦 380 · 📋 98 - 55% open · ⏱️ 14.10.2021)
  • PyPi (📥 24K / month):
     pip install mkdocs-with-pdf
    
  • Add to mkdocs.yml:
    plugins:
      - with-pdf
print-site - 🥇22 · ⭐ 88 · MIT ·
MkDocs Plugin that adds an additional page that combines all pages, allowing easy exports to PDF and standalone HTML.
  • GitHub (👨‍💻 5 · 🔀 14 · 📦 240 · 📋 79 - 10% open · ⏱️ 28.08.2023)
  • PyPi (📥 17K / month):
     pip install mkdocs-print-site-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - print-site
mkpdfs - 🥈17 · ⭐ 96 · 💤 · ❗️GPL-3.0 ·
Converts your mkdocs documentation in PDF, to be shared with users.
  • GitHub (👨‍💻 8 · 🔀 29 · 📥 34 · 📦 48 · 📋 38 - 31% open · ⏱️ 11.08.2021)
  • PyPi (📥 750 / 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 · 📦 48 · 📋 23 - 56% open · ⏱️ 14.03.2016)
  • PyPi (📥 190 / month):
     pip install mkdocs-pandoc
    
Show 4 hidden projects...
pdf-with-js - 🥉10 · ⭐ 5 · 💤 · MIT ·
A MkDocs plugin that exports your documentation as PDF with rendered JavaScript content.
  • GitHub (👨‍💻 4 · 🔀 2 · 📦 9 · ⏱️ 23.07.2021)
  • PyPi (📥 620 / month):
     pip install mkdocs-pdf-with-js-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - pdf-with-js
mk2pdf-export - 🥉6 · ⭐ 6 · 💤 · 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 (📥 74 / month):
     pip install mkdocs-mk2pdf-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - mk2pdf-export
helm - 🥉2 · ⭐ 1 · 💤 · Apache-2 ·
An mkdocs plugin that turns docs website into helm repository.
  • GitHub (🔀 1 · ⏱️ 21.11.2018)
  • PyPi (📥 13 / month):
     pip install mkdocs-helm
    
  • Add to mkdocs.yml:
    plugins:
      - helm-repo
mkdocs-autozip - 🥉1 · ⭐ 2 · ❗Unlicensed ·
A mkdocs plugin for auto zipping the document source.
  • GitHub (⏱️ 05.10.2022)
  • PyPi (📥 110 / month):
     pip install mkdocs-autozip
    
  • Add to mkdocs.yml:
    plugins:
      - autozip

🔧 Site management

Back to top

mike - 🥇25 · ⭐ 380 · BSD-3 ·
Manage multiple versions of your MkDocs-powered documentation via Git.
  • GitHub (👨‍💻 8 · 🔀 30 · 📥 150 · 📦 2.2K · 📋 150 - 5% open · ⏱️ 09.09.2023)
  • PyPi (📥 100K / month):
     pip install mike
    
  • Add to mkdocs.yml:
    plugins:
      - mike
monorepo - 🥇23 · ⭐ 260 · Apache-2 ·
Build multiple documentation folders in a single Mkdocs. Designed for large codebases.
  • GitHub (👨‍💻 30 · 🔀 65 · 📦 320 · 📋 53 - 54% open · ⏱️ 08.09.2023)
  • PyPi (📥 190K / month):
     pip install mkdocs-monorepo-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - monorepo
mkdocs-multirepo-plugin - 🥈21 · ⭐ 89 · MIT ·
Build documentation in multiple repos into one site.
  • GitHub (👨‍💻 12 · 🔀 29 · 📦 86 · 📋 77 - 42% open · ⏱️ 07.09.2023)
  • PyPi (📥 26K / month):
     pip install mkdocs-multirepo-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - multirepo
simple - 🥈21 · ⭐ 37 · Apache-2 ·
Build documentation files inside your code into a MkDocs site.
  • GitHub (👨‍💻 8 · 🔀 11 · 📦 39 · ⏱️ 16.09.2023)
  • PyPi (📥 16K / 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 · 📦 61 · 📋 25 - 12% open · ⏱️ 01.08.2021)
  • PyPi (📥 3.4K / month):
     pip install mkdocs-versioning
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-versioning
MkDocs Merge - 🥉11 · ⭐ 20 · MIT
Merge the source of multiple MkDocs sites into a single one.
  • GitHub (👨‍💻 3 · 🔀 5 · 📦 4 · 📋 7 - 57% open · ⏱️ 21.01.2023)
  • PyPi (📥 740 / month):
     pip install mkdocs-merge
    
multirepo - 🥉9 · ⭐ 28 · 💤 · MIT
A bit like monorepo, but keeps MkDocs projects separate.
  • GitHub (👨‍💻 2 · 🔀 2 · ⏱️ 11.01.2022)
  • PyPi (📥 110 / month):
     pip install mkdocs-multirepo
    
Show 6 hidden projects...
mkdocs-yamp - 🥉9 · ⭐ 1 · Apache-2 ·
Yet Another Multirepo Plugin for MkDocs.
  • GitHub (👨‍💻 2 · 🔀 1 · 📦 3 · ⏱️ 10.10.2022)
  • PyPi (📥 320 / month):
     pip install mkdocs-yamp
    
  • Add to mkdocs.yml:
    plugins:
      - yamp
mkdocs-exclude-unused-files - 🥉7 · ⭐ 1 · MIT ·
Exclude orphaned (unused) static files from your mkdocs build.
  • GitHub (👨‍💻 2 · 🔀 1 · 📦 1 · ⏱️ 24.05.2023)
  • PyPi (📥 240 / month):
     pip install mkdocs-exclude-unused-files
    
  • Add to mkdocs.yml:
    plugins:
      - exclude-unused-files
progress - 🥉6 · ⭐ 4 · 💤 · Apache-2 ·
A plugin for MkDocs that lets you know exactly what is happening during the build.
  • GitHub (👨‍💻 3 · 📦 22 · ⏱️ 20.06.2020)
  • Add to mkdocs.yml:
    plugins:
      - progress
mkdocs-exclude-tagged-files - 🥉5 · ⭐ 2 · MIT ·
A mkdocs plugin for excluding files based on frontmatter tags.
  • GitHub (👨‍💻 2 · 🔀 2 · 📦 1 · ⏱️ 10.09.2023)
  • PyPi (📥 130 / 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 (📥 440 / month):
     pip install mkdocs-new-features-notifier
    
  • Add to mkdocs.yml:
    plugins:
      - mkdocs-new-features-notifier
multiple - 🥉4 · ⭐ 1 · 💤 · ❗️GPL-3.0 ·
Allows to merge mkdocs documentations dynamically.
  • GitHub (⏱️ 22.11.2019)
  • PyPi (📥 1.1K / month):
     pip install mkdocs-multiple
    
  • Add to mkdocs.yml:
    plugins:
      - multiple

📁 Snippets & includes (reusing contents)

Back to top

include-markdown - 🥇25 · ⭐ 70 · Apache-2 ·
Mkdocs Markdown includer plugin.
  • GitHub (👨‍💻 13 · 🔀 15 · 📥 190 · 📦 1.6K · 📋 61 - 1% open · ⏱️ 31.08.2023)
  • PyPi (📥 120K / month):
     pip install mkdocs-include-markdown-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - include-markdown
Markdown-Include - 🥈21 · ⭐ 89 · ❗️GPL-3.0 ·
Provides syntax for Python-Markdown which allows for the inclusion of the contents of other Markdown documents.
  • GitHub (👨‍💻 12 · 🔀 36 · 📦 5K · 📋 22 - 27% open · ⏱️ 07.02.2023)
  • PyPi (📥 66K / month):
     pip install markdown-include
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - markdown_include.include
Mdx Include - 🥉9 · ⭐ 50 · 💤 · ❗Unlicensed ·
Python Markdown extension to include local or remote files.
  • GitHub (👨‍💻 3 · 🔀 2 · 📋 8 - 37% open · ⏱️ 26.07.2022)
  • PyPi (📥 11K / month):
     pip install mdx_include
    
  • Add to mkdocs.yml:
    markdown_extensions:
      - mdx_include
Show 6 hidden projects...
meta-descriptions - 🥈19 · ⭐ 13 · MIT ·
Generate meta descriptions from the first paragraphs in your MkDocs pages.
  • GitHub (👨‍💻 3 · 🔀 3 · 📦 690 · 📋 11 - 9% open · ⏱️ 12.09.2023)
  • PyPi (📥 6.6K / month):
     pip install mkdocs-meta-descriptions-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - meta-descriptions
mkdocs-embed-external-markdown - 🥈15 · ⭐ 6 · 📉 · MIT ·
MkDocs Embed External Markdown plugin that allow to inject section or all full markdown content from a given url. The..
  • GitHub (👨‍💻 4 · 🔀 6 · 📦 96 · 📋 8 - 12% open · ⏱️ 27.06.2023)
  • PyPi (📥 10K / month):
     pip install mkdocs-embed-external-markdown
    
  • Add to mkdocs.yml:
    plugins:
      - external-markdown
codeinclude - 🥉14 · ⭐ 14 · MIT ·
A plugin to include code snippets into mkdocs pages.
  • GitHub (👨‍💻 4 · 🔀 5 · 📦 97 · 📋 11 - 45% open · ⏱️ 01.03.2023)
  • PyPi (📥 3.7K / month):
     pip install mkdocs-codeinclude-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - codeinclude
snippet - 🥉10 · ⭐ 12 · 💤 · MIT ·
An mkdocs plugin that injects snippets from a file in a git repository.
  • GitHub (👨‍💻 3 · 🔀 3 · 📦 11 · 📋 7 - 42% open · ⏱️ 21.10.2021)
  • PyPi (📥 530 / month):
     pip install mkdocs-snippet-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - snippet
mkdocs-version-annotations - 🥉10 · ⭐ 1 · MIT ·
MkDocs plugin to add custom admonitions for documenting version differences.
  • GitHub (📥 8 · 📦 180 · ⏱️ 14.09.2022)
  • PyPi (📥 6.9K / 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 · 📦 6 · ⏱️ 15.11.2020)
  • PyPi (📥 370 / month):
     pip install mkdocs-gitsnippet-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - gitsnippet

👽 Other

Back to top

techdocs-core - 🥇21 · ⭐ 58 · Apache-2 ·
The core MkDocs plugin used by Backstages TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown..
  • GitHub (👨‍💻 34 · 🔀 46 · 📦 40 · 📋 45 - 8% open · ⏱️ 08.09.2023)
  • PyPi (📥 240K / month):
     pip install mkdocs-techdocs-core
    
  • Add to mkdocs.yml:
    plugins:
      - techdocs-core
same-dir - 🥈13 · ⭐ 23 · MIT ·
MkDocs plugin to allow placing mkdocs.yml in the same directory as documentation.
  • GitHub (👨‍💻 2 · 🔀 2 · 📦 190 · ⏱️ 10.09.2023)
  • PyPi (📥 9.5K / month):
     pip install mkdocs-same-dir
    
  • Add to mkdocs.yml:
    plugins:
      - same-dir
no-sitemap - 🥉6 · 🐣 · MIT ·
Disable Mkdocs sitemap generation.
  • GitHub (📦 5 · ⏱️ 04.04.2023)
  • PyPi (📥 1.3K / month):
     pip install mkdocs-no-sitemap-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - no-sitemap
Family tree example - 🥉5 · ❗️GPL-3.0
An interactive family tree visualization using d3-dag.
  • GitHub (👨‍💻 5 · 🔀 1 · ⏱️ 04.08.2023)
Show 6 hidden projects...
bibtex - 🥈19 · ⭐ 48 · ❗️BSD-3-Clause-LBNL ·
A MkDocs plugin for citation management using bibtex.
  • GitHub (👨‍💻 10 · 🔀 14 · 📦 180 · 📋 35 - 22% open · ⏱️ 01.09.2023)
  • PyPi (📥 4K / month):
     pip install mkdocs-bibtex
    
  • Add to mkdocs.yml:
    plugins:
      - bibtex
placeholder - 🥈8 · ⭐ 6 · MIT ·
Add placeholders to your MkDocs pages.
  • GitHub (👨‍💻 2 · 🔀 2 · ⏱️ 01.08.2023)
  • PyPi (📥 520 / month):
     pip install mkdocs-placeholder-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - placeholder
vim-md-tags - 🥈8 · ⭐ 4 · 💤 · MIT ·
An MkDocs plugin that creates a vim tag file of all markdown files.
  • GitHub (👨‍💻 4 · 🔀 1 · 📦 9 · ⏱️ 08.05.2020)
  • PyPi (📥 100 / month):
     pip install mkdocs-vim-md-tags-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - vim-md-tags
badges - 🥈8 · ⭐ 3 · MIT ·
Add badges to your mkdocs page.
  • GitHub (🔀 1 · 📋 4 - 25% open · ⏱️ 05.09.2023)
  • PyPi (📥 670 / month):
     pip install mkdocs-badges
    
  • Add to mkdocs.yml:
    plugins:
      - badges
thumbnails - 🥉5 · ⭐ 2 · MIT ·
MkDocs plugin for thumbnail images generated automatically.
  • GitHub (📋 2 - 50% open · ⏱️ 05.06.2023)
  • PyPi (📥 310 / month):
     pip install mkdocs-thumbnails
    
  • Add to mkdocs.yml:
    plugins:
      - thumbnails
pico-8 - 🥉4 · ⭐ 1 · 💤 · MIT ·
A MKDocs plugin that allows to embed a Pico-8 web player in a page.
  • GitHub (📦 1 · ⏱️ 17.03.2019)
  • PyPi (📥 65 / month):
     pip install pico8-mkdocs-plugin
    
  • Add to mkdocs.yml:
    plugins:
      - pico-8

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