search

mkdocs / catalog

:trophy: :books: A list of awesome MkDocs projects and plugins.
Creative Commons Attribution Share Alike 4.0 International
1.08k stars 65 forks source link
best-of best-of-list mkdocs

readme

catalog

:trophy: :books: A list of awesome MkDocs projects and plugins.

This list contains 280 awesome open-source projects grouped into 17 categories. All projects are ranked by a project-quality score, which is calculated based on various metrics automatically collected from GitHub and different package managers. If you want to add or update projects, feel free to open an issue, 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


🎨 Theming

Back to top

Material for MkDocs - 🥇42 · ⭐ 21K · MIT · ·
Documentation that simply works. - [GitHub](https://github.com/squidfunk/mkdocs-material) (👨‍💻 290 · 🔀 3.4K · 📦 55K · 📋 2.4K - 0% open · ⏱️ 31.10.2024) - [PyPi](https://pypi.org/project/mkdocs-material) (📥 5.5M / month): ``` pip install mkdocs-material ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: material ``` Extras: ```yaml plugins: - blog - group - offline - search - social - tags ```
Cinder - 🥇20 · ⭐ 210 · 💤 · ❗Unlicensed ·
A clean, responsive MkDocs theme. - [GitHub](https://github.com/chrissimpkins/cinder) (👨‍💻 23 · 🔀 100 · 📥 1K · 📦 660 · 📋 51 - 31% open · ⏱️ 05.01.2021) - [PyPi](https://pypi.org/project/mkdocs-cinder) (📥 7.4K / month): ``` pip install mkdocs-cinder ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: cinder ```
Bootswatch - 🥇19 · ⭐ 140 · BSD-2 ·
MkDocs Bootswatch Themes. - [GitHub](https://github.com/mkdocs/mkdocs-bootswatch) (👨‍💻 10 · 🔀 58 · 📦 1.1K · 📋 33 - 9% open · ⏱️ 29.12.2023) - [PyPi](https://pypi.org/project/mkdocs-bootswatch) (📥 15K / month): ``` pip install mkdocs-bootswatch ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: cerulean theme: cosmo theme: cyborg theme: darkly theme: flatly theme: journal theme: litera theme: lumen theme: lux theme: materia theme: minty theme: pulse theme: sandstone theme: simplex theme: slate theme: solar theme: spacelab theme: superhero theme: united theme: yeti ```
Terminal for MkDocs - 🥈18 · ⭐ 120 · MIT ·
monospace theme for MkDocs. - [GitHub](https://github.com/ntno/mkdocs-terminal) (🔀 5 · 📦 93 · 📋 59 - 45% open · ⏱️ 20.08.2024) - [PyPi](https://pypi.org/project/mkdocs-terminal) (📥 5.5K / month): ``` pip install mkdocs-terminal ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: terminal ``` Extras: ```yaml plugins: - md-to-html ```
Simple Blog - 🥈18 · ⭐ 79 · MIT ·
Blog Template for Mkdocs. - [GitHub](https://github.com/FernandoCelmer/mkdocs-simple-blog) (👨‍💻 3 · 🔀 5 · 📦 76 · 📋 20 - 45% open · ⏱️ 27.10.2024) - [PyPi](https://pypi.org/project/mkdocs-simple-blog) (📥 2.1K / month): ``` pip install mkdocs-simple-blog ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: simple-blog ```
Bootstrap - 🥈17 · ⭐ 84 · 📈 · BSD-2 ·
MkDocs Bootstrap Theme. - [GitHub](https://github.com/mkdocs/mkdocs-bootstrap) (👨‍💻 6 · 🔀 36 · 📦 480 · 📋 16 - 6% open · ⏱️ 29.12.2023) - [PyPi](https://pypi.org/project/mkdocs-bootstrap) (📥 12K / month): ``` pip install mkdocs-bootstrap ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: bootstrap ```
Dracula - 🥈17 · ⭐ 77 · MIT ·
Dark theme for Mkdocs. - [GitHub](https://github.com/dracula/mkdocs) (👨‍💻 4 · 🔀 9 · 📦 110 · 📋 14 - 7% open · ⏱️ 17.01.2024) - [PyPi](https://pypi.org/project/mkdocs-dracula-theme) (📥 2.1K / month): ``` pip install mkdocs-dracula-theme ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: dracula ```
Windmill - 🥈14 · ⭐ 110 · 💤 · ❗Unlicensed ·
Outstanding mkdocs theme with a focus on navigation and usability. - [GitHub](https://github.com/gristlabs/mkdocs-windmill) (👨‍💻 8 · 🔀 47 · 📦 320 · 📋 31 - 48% open · ⏱️ 11.03.2022) - [PyPi](https://pypi.org/project/mkdocs-windmill) (📥 3.4K / month): ``` pip install mkdocs-windmill ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: windmill ```
Torillic - 🥈14 · ⭐ 100 · ❗️CC0-1.0 ·
A D&D inspired theme for styling TTRPG notes and resources. - [GitHub](https://github.com/TEParsons/torillic) (👨‍💻 4 · 🔀 90 · 📥 7.4K · ⏱️ 05.09.2024) - [PyPi](https://pypi.org/project/mkdocs-torillic) (📥 960 / month): ``` pip install mkdocs-torillic ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: torillic ```
Zettelkasten - 🥈11 · ⭐ 15 · MIT ·
This is a Zettelkasten theme and plugin for MkDocs. It renders the MkDocs pages as cards (zettels). - [GitHub](https://github.com/buvis/mkdocs-zettelkasten) (👨‍💻 3 · 🔀 3 · 📥 26 · 📦 6 · 📋 11 - 72% open · ⏱️ 07.07.2024) - [PyPi](https://pypi.org/project/mkdocs-zettelkasten) (📥 670 / month): ``` pip install mkdocs-zettelkasten ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: zettelkasten-solarized-light ``` Extras: ```yaml plugins: - zettelkasten ```
Lantana - 🥈11 · ⭐ 14 · MIT ·
Lantana MKDocsHTML. - [GitHub](https://github.com/WSOFT-Project/lantana) (👨‍💻 3 · 📥 360 · 📦 5 · 📋 19 - 5% open · ⏱️ 12.05.2024) - [PyPi](https://pypi.org/project/lantana) (📥 4.9K / month): ``` pip install lantana ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: lantana ```
Ivory - 🥈11 · ⭐ 10 · 💤 · MIT ·
Ivory theme for MkDocs. - [GitHub](https://github.com/daizutabi/mkdocs-ivory) (👨‍💻 2 · 🔀 4 · 📦 89 · 📋 5 - 40% open · ⏱️ 16.06.2020) - [PyPi](https://pypi.org/project/mkdocs-ivory) (📥 3K / month): ``` pip install mkdocs-ivory ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: ivory ```
KPN for MkDocs - 🥈11 · ⭐ 8 · MIT ·
KPN theme for MkDocs | owner=flow. - [GitHub](https://github.com/kpn/mkdocs-kpn-theme) (👨‍💻 3 · 📦 5 · ⏱️ 31.01.2024) - [PyPi](https://pypi.org/project/mkdocs-kpn) (📥 3.5K / month): ``` pip install mkdocs-kpn ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: kpn ```
SWAN - 🥈11 · ⭐ 7 · ❗️AGPL-3.0 ·
SWAN MkDocs theme. - [GitHub](https://github.com/swan-cern/mkdocs-swan) (👨‍💻 4 · 🔀 3 · 📦 9 · ⏱️ 23.01.2024) - [PyPi](https://pypi.org/project/mkdocs-swan) (📥 670 / month): ``` pip install mkdocs-swan ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: swan ```
Bootstrap 4 - 🥈11 · ⭐ 6 · MIT ·
A vanilla Bootstrap 4 theme for MkDocs. - [GitHub](https://github.com/LukeCarrier/mkdocs-theme-bootstrap4) (👨‍💻 3 · 📦 8 · 📋 5 - 20% open · ⏱️ 07.06.2024) - [PyPi](https://pypi.org/project/mkdocs-theme-bootstrap4) (📥 280 / month): ``` pip install mkdocs-theme-bootstrap4 ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: bootstrap4 ``` Extras: ```yaml plugins: - bootstrap4-blockquotes - bootstrap4-tables ```
CustomMill - 🥉9 · ⭐ 12 · 💤 · ❗Unlicensed ·
Outstanding mkdocs theme with a focus on navigation, customization and usability. - [GitHub](https://github.com/Siphalor/mkdocs-custommill) (👨‍💻 8 · 🔀 6 · 📦 21 · ⏱️ 10.03.2022) - [PyPi](https://pypi.org/project/mkdocs-custommill) (📥 1.1K / month): ``` pip install mkdocs-custommill ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: custommill ```
Landing - 🥉9 · ⭐ 3 · 🐣 · ❗Unlicensed ·
An mkdocs theme geared towards making a personal landing page, with simpler navigation and heavily customisable style.. - [GitHub](https://github.com/TEParsons/mkdocs-landing) (👨‍💻 2 · 📥 2 · ⏱️ 25.10.2024) - [PyPi](https://pypi.org/project/mkdocs-landing) (📥 950 / month): ``` pip install mkdocs-landing ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: landing ```
Alabaster - 🥉8 · ⭐ 36 · 💤 · ❗Unlicensed ·
Alabaster port for MkDocs. - [GitHub](https://github.com/notpushkin/mkdocs-alabaster) (👨‍💻 9 · 🔀 10 · 📋 17 - 17% open · ⏱️ 16.06.2020) - [PyPi](https://pypi.org/project/mkdocs-alabaster) (📥 870 / month): ``` pip install mkdocs-alabaster ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: alabaster ```
Windmill Dark - 🥉8 · ⭐ 33 · 💤 · ❗Unlicensed ·
Outstanding mkdocs theme with a focus on navigation and usability. - [GitHub](https://github.com/noraj/mkdocs-windmill-dark) (👨‍💻 4 · 🔀 10 · ⏱️ 12.05.2022) - [PyPi](https://pypi.org/project/mkdocs-windmill-dark) (📥 700 / month): ``` pip install mkdocs-windmill-dark ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: windmill-dark ```
GitBook - 🥉8 · ⭐ 28 · 💤 · ❗Unlicensed ·
Default theme for GitBook for Mkdocs https://lramage.gitlab.io/mkdocs-gitbook-theme. - [PyPi](https://pypi.org/project/mkdocs-gitbook) (📥 11K / month): ``` pip install mkdocs-gitbook ``` - [GitLab](https://gitlab.com/lramage/mkdocs-gitbook-theme) (🔀 13 · 📋 19 - 47% open · ⏱️ 17.12.2018) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: gitbook ```
Moonstone - 🥉8 · ⭐ 7 · 💤 · ❗Unlicensed ·
A documentation theme for mkdocs. - [GitHub](https://github.com/byrnereese/mkdocs-moonstone) (🔀 1 · 📦 12 · ⏱️ 15.06.2021) - [PyPi](https://pypi.org/project/mkdocs-moonstone) (📥 1.6K / month): ``` pip install mkdocs-moonstone ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: moonstone ```
Nature - 🥉8 · ⭐ 5 · 💤 · ❗Unlicensed ·
A MkDocs theme. - [GitHub](https://github.com/waylan/mkdocs-nature) (👨‍💻 2 · 🔀 1 · 📦 44 · ⏱️ 14.09.2023) - [PyPi](https://pypi.org/project/mkdocs-nature) (📥 1.1K / month): ``` pip install mkdocs-nature ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: nature ```
Risonia - 🥉8 · ⭐ 4 · 💤 · ❗Unlicensed ·
A simple theme for MkDocs, using the w3.css framework and configurable color schemes. - [GitHub](https://github.com/unverbuggt/mkdocs-risonia-theme) (🔀 1 · 📦 4 · ⏱️ 01.09.2023) - [PyPi](https://pypi.org/project/mkdocs-risonia-theme) (📥 680 / month): ``` pip install mkdocs-risonia-theme ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: risonia ``` Extras: ```yaml plugins: - color-theme - w3css-classes ```
BOOTSTRAP386 - 🥉7 · ⭐ 32 · 💤 · ❗Unlicensed ·
A vintage 1980s DOS inspired Twitter Bootstrap theme for MkDocs https://lramage.gitlab.io/mkdocs-bootstrap386. - [PyPi](https://pypi.org/project/mkdocs-bootstrap386) (📥 5.4K / month): ``` pip install mkdocs-bootstrap386 ``` - [GitLab](https://gitlab.com/lramage/mkdocs-bootstrap386) (🔀 3 · 📋 7 - 57% open · ⏱️ 06.06.2018) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: bootstrap386 ```
mkdocs-theme-topdf - 🥉7 · ⭐ 13 · 💤 · MPL-2.0 ·
A mkdocs theme for create PDF and printing with paged.js. - [GitHub](https://github.com/kuri65536/mkdocs-theme-topdf) (🔀 1 · 📦 4 · ⏱️ 26.06.2021) - [PyPi](https://pypi.org/project/mkdocs-theme-topdf) (📥 260 / month): ``` pip install mkdocs-theme-topdf ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: topdf ```
docSkimmer - 🥉6 · ⭐ 18 · ❗Unlicensed ·
An accessible, skimmable theme for MkDocs. - [GitHub](https://github.com/hfagerlund/mkdocs-docskimmer) (⏱️ 05.11.2023) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: docskimmer ```
GitHub - 🥉6 · ⭐ 2 · 💤 · MIT ·
Theme Mkdocs Like a Github. DEMO =. - [GitHub](https://github.com/g3xx/mkdocs-Github) (📦 11 · ⏱️ 25.02.2020) - [PyPi](https://pypi.org/project/mkdocs-github) (📥 140 / month): ``` pip install mkdocs-github ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: github ```
mkdocs-rtl - 🥉4 · ⭐ 24 · 💤 · MIT
mkdocs rtl theme based on mkdocs-material. - [GitHub](https://github.com/mberneti/mkdocs-rtl) (👨‍💻 2 · 🔀 4 · 📋 2 - 50% open · ⏱️ 22.10.2017)
Cluster - 🥉3 · ⭐ 4 · 💤 · ❗Unlicensed ·
Another bootstrap theme for MkDocs. - [PyPi](https://pypi.org/project/mkdocs-cluster) (📥 860 / month): ``` pip install mkdocs-cluster ``` - [GitLab](https://gitlab.com/kaliko/mkdocs-cluster) (🔀 1 · ⏱️ 02.06.2016) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#theme): ```yaml theme: cluster ```


💻 API documentation building

Back to top

mkdocstrings - 🥇32 · ⭐ 1.7K · ISC ·
Automatic documentation from sources, for MkDocs. - [GitHub](https://github.com/mkdocstrings/mkdocstrings) (👨‍💻 45 · 🔀 110 · 📦 16K · 📋 410 - 13% open · ⏱️ 12.10.2024) - [PyPi](https://pypi.org/project/mkdocstrings) (📥 1.7M / month): ``` pip install mkdocstrings ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocstrings ```
MkApi - 🥇24 · ⭐ 100 · MIT ·
A plugin for MkDocs to generate API documentation. - [GitHub](https://github.com/daizutabi/mkapi) (👨‍💻 5 · 🔀 17 · 📦 190 · 📋 130 - 2% open · ⏱️ 15.10.2024) - [PyPi](https://pypi.org/project/mkapi) (📥 8.9K / month): ``` pip install mkapi ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkapi ```
mkdocstrings-python - 🥈23 · ⭐ 190 · ISC
A Python handler for mkdocstrings. - [GitHub](https://github.com/mkdocstrings/python) (👨‍💻 19 · 🔀 35 · 📋 140 - 25% open · ⏱️ 19.10.2024) - [PyPi](https://pypi.org/project/mkdocstrings-python) (📥 2.3M / month): ``` pip install mkdocstrings-python ```
MkDocsOAD - 🥈19 · ⭐ 120 · MIT · ·
Plugin for MkDocs to generate human readable documentation from OpenAPI Documentation Version 3 (also known as Swagger.. - [GitHub](https://github.com/Neoteroi/mkdocs-plugins) (👨‍💻 10 · 🔀 9 · 📥 3K · 📦 280 · 📋 41 - 41% open · ⏱️ 04.09.2024) - [PyPi](https://pypi.org/project/neoteroi-mkdocs) (📥 38K / month): ``` pip install neoteroi-mkdocs ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - neoteroi.mkdocsoad - neoteroi.contribs markdown_extensions: - neoteroi.cards - neoteroi.timeline - neoteroi.projects - neoteroi.spantable ```
mkdocs-click - 🥈18 · ⭐ 110 · Apache-2 ·
An MkDocs extension to generate documentation for Click command line applications. - [GitHub](https://github.com/mkdocs/mkdocs-click) (👨‍💻 13 · 🔀 16 · 📦 610 · 📋 30 - 50% open · ⏱️ 11.02.2024) - [PyPi](https://pypi.org/project/mkdocs-click) (📥 45K / month): ``` pip install mkdocs-click ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mkdocs-click ```
mkdoxy - 🥈18 · ⭐ 76 · MIT ·
Automatically generates API documentation for your project based on Doxygen comments and code snippets in your.. - [GitHub](https://github.com/JakubAndrysek/MkDoxy) (👨‍💻 12 · 🔀 19 · 📦 26 · 📋 54 - 18% open · ⏱️ 18.06.2024) - [PyPi](https://pypi.org/project/mkdoxy) (📥 18K / month): ``` pip install mkdoxy ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdoxy ```
mkdocstrings-crystal - 🥈18 · ⭐ 28 · MIT
Crystal language doc generator for https://github.com/mkdocstrings/mkdocstrings. - [GitHub](https://github.com/mkdocstrings/crystal) (👨‍💻 3 · 🔀 3 · 📦 740 · 📋 4 - 75% open · ⏱️ 03.02.2024) - [PyPi](https://pypi.org/project/mkdocstrings-crystal) (📥 14K / month): ``` pip install mkdocstrings-crystal ```
MkAutoDoc - 🥈16 · ⭐ 220 · 💤 · ❗️BSD ·
Auto documentation for MkDocs. - [GitHub](https://github.com/tomchristie/mkautodoc) (👨‍💻 7 · 🔀 17 · 📦 840 · 📋 18 - 38% open · ⏱️ 26.09.2022) - [PyPi](https://pypi.org/project/mkautodoc) (📥 14K / month): ``` pip install mkautodoc ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mkautodoc ```
mktheapidocs - 🥉14 · ⭐ 12 · 💤 · MIT ·
Numpydocs - mkdocs friendly markdown. - [GitHub](https://github.com/greenape/mktheapidocs) (👨‍💻 6 · 🔀 3 · 📦 43 · 📋 16 - 62% open · ⏱️ 10.06.2022) - [PyPi](https://pypi.org/project/mktheapidocs) (📥 1.1K / month): ``` pip install mktheapidocs ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mktheapidocs ```
mkdocstrings-vba - 🥉14 · ⭐ 3 · ISC
VBA handler for mkdocstrings. - [GitHub](https://github.com/mkdocstrings/vba) (👨‍💻 3 · 🔀 1 · 📦 3 · 📋 9 - 22% open · ⏱️ 01.10.2024) - [PyPi](https://pypi.org/project/mkdocstrings-vba) (📥 330 / month): ``` pip install mkdocstrings-vba ```
mkdocs-typer - 🥉12 · ⭐ 28 · 💤 · Apache-2 ·
An MkDocs extension to generate documentation for Typer command line applications. - [GitHub](https://github.com/bruce-szalwinski/mkdocs-typer) (🔀 2 · 📋 7 - 57% open · ⏱️ 21.06.2023) - [PyPi](https://pypi.org/project/mkdocs-typer) (📥 9.4K / month): ``` pip install mkdocs-typer ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mkdocs-typer ```
automacdoc - 🥉8 · ⭐ 42 · 💤 · MIT
Automatic generation of documentation for mkdocs. - [GitHub](https://github.com/AlexandreKempf/automacdoc) (👨‍💻 6 · 🔀 10 · 📋 5 - 80% open · ⏱️ 29.12.2020) - [PyPi](https://pypi.org/project/automacdoc) (📥 310 / 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](https://github.com/JakubAndrysek/mkdocs-typedoc) (👨‍💻 2 · 🔀 1 · ⏱️ 03.05.2024) - [PyPi](https://pypi.org/project/mkdocs-typedoc) (📥 1.3K / month): ``` pip install mkdocs-typedoc ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - typedoc ```
inari - 🥉7 · ⭐ 5 · 💤 · MIT ·
Write docstrings in markdown!. - [GitHub](https://github.com/tkamenoko/inari) (📦 8 · 📋 2 - 50% open · ⏱️ 10.07.2021) - [PyPi](https://pypi.org/project/inari) (📥 420 / month): ``` pip install inari ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - inari ```
mkdocstrings-shell - 🥉7 · ⭐ 1 · ISC
A shell scripts/libraries handler for mkdocstrings. - [GitHub](https://github.com/mkdocstrings/shell) (📦 3 · ⏱️ 12.10.2024)
mkdocs-pipeline-visualizer - 🥉7 · ⭐ 1 · 🐣 · BSD-2 ·
Generates MD documentation from tekton pipelines and tasks. - [GitHub](https://github.com/obegron/mkdocs-pipeline-visualizer) (👨‍💻 2 · 📦 1 · ⏱️ 09.09.2024) - [PyPi](https://pypi.org/project/mkdocs-pipeline-visualizer) (📥 590 / month): ``` pip install mkdocs-pipeline-visualizer ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - pipeline-visualizer ```
doxygen - 🥉6 · ⭐ 14 · 💤 · MIT ·
A Doxygen plugin for MkDocs. - [GitHub](https://github.com/pieterdavid/mkdocs-doxygen-plugin) (👨‍💻 3 · 🔀 5 · ⏱️ 04.12.2020) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - doxygen ```
mkdocs-yaarg-plugin - 🥉3 · ⭐ 2 · 💤 · ❗Unlicensed ·
Yet Another API Reference Generator plugin for MKDocs. - [GitHub](https://github.com/g6123/mkdocs-yaarg-plugin) (📦 2 · ⏱️ 14.03.2021) - [PyPi](https://pypi.org/project/mkdocs-yaarg-plugin) (📥 360 / month): ``` pip install mkdocs-yaarg-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - yaarg ```
ansible-document - 🥉3 · ❗Unlicensed
Auto-generate ansible role documentation. - [PyPi](https://pypi.org/project/ansible-mkdocs) (📥 860 / month): ``` pip install ansible-mkdocs ```


💬 Blogging

Back to top

rss - 🥇24 · ⭐ 86 · MIT ·
MkDocs plugin to generate a RSS feeds for created and updated pages, using git log and YAML frontmatter (page.meta). - [GitHub](https://github.com/Guts/mkdocs-rss-plugin) (👨‍💻 17 · 🔀 27 · 📥 160 · 📦 720 · 📋 52 - 26% open · ⏱️ 01.11.2024) - [PyPi](https://pypi.org/project/mkdocs-rss-plugin) (📥 51K / month): ``` pip install mkdocs-rss-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - rss ```
mkdocs-blogging-plugin - 🥈19 · ⭐ 84 · 💤 · MIT ·
Add blogging feature to your MkDocs site. - [GitHub](https://github.com/liang2kl/mkdocs-blogging-plugin) (👨‍💻 7 · 🔀 16 · 📥 19 · 📦 240 · 📋 41 - 12% open · ⏱️ 21.07.2023) - [PyPi](https://pypi.org/project/mkdocs-blogging-plugin) (📥 10K / month): ``` pip install mkdocs-blogging-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - blogging ```
Publisher for MkDocs - blog - 🥈16 · ⭐ 61 · MIT ·
Blogging engine with support for categories, tags and archive. - [GitHub](https://github.com/mkdocs-publisher/mkdocs-publisher) (👨‍💻 2 · 🔀 2 · 📥 54 · 📦 61 · 📋 21 - 28% open · ⏱️ 11.08.2024) - [PyPi](https://pypi.org/project/mkdocs-publisher) (📥 2.6K / month): ``` pip install mkdocs-publisher ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - pub-blog ```
newsletter - 🥉12 · ⭐ 31 · ❗️GPL-3.0 ·
Automatically create newsletters from the changes in a mkdocs repository. - [GitHub](https://github.com/lyz-code/mkdocs-newsletter) (👨‍💻 3 · 🔀 2 · 📦 47 · 📋 10 - 30% open · ⏱️ 27.05.2024) - [PyPi](https://pypi.org/project/mkdocs-newsletter) (📥 1.1K / month): ``` pip install mkdocs-newsletter ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs-newsletter ```
Blogs for MkDocs - 🥉12 · ⭐ 17 · 💤 · MIT ·
This plugin for MkDocs allows to keeps a really simple blog section inside your documentation site. - [GitHub](https://github.com/fmaida/mkdocs-blog-plugin) (🔀 4 · 📦 120 · 📋 2 - 50% open · ⏱️ 13.04.2020) - [PyPi](https://pypi.org/project/mkdocs-blog-plugin) (📥 2K / month): ``` pip install mkdocs-blog-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - blog ```
python-mkblog - 🥉4 · ⭐ 2 · 💤 · MIT ·
This is a MkDocs Plugin adding basic blogging functionality by parsing a `blog` directory ontop of your usual `docs`.. - [GitHub](https://github.com/derJD/python-mkblog) (👨‍💻 2 · 🔀 1 · ⏱️ 14.04.2021) - [PyPi](https://pypi.org/project/mkblog) (📥 230 / month): ``` pip install mkblog ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkblog ```
blog - 🥉3 · ⭐ 14 · 💤 · ❗Unlicensed ·
Blogging in mkdocs. - [GitHub](https://github.com/andyoakley/mkdocs-blog) (🔀 7 · 📋 5 - 80% open · ⏱️ 02.11.2020) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - blog ```


📊 Charts, Images, Tables & Graphs

Back to top

plantuml-markdown - 🥇28 · ⭐ 200 · BSD-2 ·
PlantUML plugin for Python-Markdown. - [GitHub](https://github.com/mikitex70/plantuml-markdown) (👨‍💻 29 · 🔀 55 · 📦 1.5K · 📋 71 - 2% open · ⏱️ 12.09.2024) - [PyPi](https://pypi.org/project/plantuml-markdown) (📥 320K / month): ``` pip install plantuml-markdown ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - plantuml_markdown ```
mermaid2 - 🥇23 · ⭐ 220 · MIT ·
A Mermaid graphs plugin for mkdocs. - [GitHub](https://github.com/fralau/mkdocs-mermaid2-plugin) (👨‍💻 15 · 🔀 28 · 📦 2.3K · 📋 71 - 12% open · ⏱️ 02.11.2024) - [PyPi](https://pypi.org/project/mkdocs-mermaid2-plugin) (📥 210K / month): ``` pip install mkdocs-mermaid2-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mermaid2 ```
kroki - 🥇22 · ⭐ 50 · MIT ·
MkDocs plugin for Kroki-Diagrams. - [GitHub](https://github.com/AVATEAM-IT-SYSTEMHAUS/mkdocs-kroki-plugin) (👨‍💻 16 · 🔀 27 · 📦 46 · 📋 40 - 15% open · ⏱️ 28.07.2024) - [PyPi](https://pypi.org/project/mkdocs-kroki-plugin) (📥 43K / month): ``` pip install mkdocs-kroki-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - kroki ```
MkDocs GLightbox - 🥇21 · ⭐ 130 · 📉 · MIT ·
A MkDocs plugin supports image lightbox (zoom effect) with GLightbox. - [GitHub](https://github.com/blueswen/mkdocs-glightbox) (👨‍💻 7 · 🔀 15 · 📥 35 · 📦 3.4K · 📋 44 - 40% open · ⏱️ 16.10.2024) - [PyPi](https://pypi.org/project/mkdocs-glightbox) (📥 280K / month): ``` pip install mkdocs-glightbox ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - glightbox ```
mkdocs_puml - 🥇21 · ⭐ 30 · MIT ·
Inline PlantUML diagrams in your MkDocs documentation. - [GitHub](https://github.com/MikhailKravets/mkdocs_puml) (👨‍💻 6 · 🔀 9 · ⏱️ 25.10.2024) - [PyPi](https://pypi.org/project/mkdocs-puml) (📥 17K / month): ``` pip install mkdocs-puml ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - plantuml ```
charts - 🥈20 · ⭐ 82 · MIT ·
Mkdocs plugin to add plots from data using vegalite. - [GitHub](https://github.com/timvink/mkdocs-charts-plugin) (👨‍💻 4 · 🔀 6 · 📦 78 · 📋 20 - 15% open · ⏱️ 22.10.2024) - [PyPi](https://pypi.org/project/mkdocs-charts-plugin) (📥 9.1K / month): ``` pip install mkdocs-charts-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - charts ```
table-reader - 🥈19 · ⭐ 130 · MIT ·
MkDocs plugin that enables a markdown tag like {{ read_csv(table.csv) }} to directly insert various table formats into.. - [GitHub](https://github.com/timvink/mkdocs-table-reader-plugin) (👨‍💻 8 · 🔀 20 · 📋 52 - 1% open · ⏱️ 08.09.2024) - [PyPi](https://pypi.org/project/mkdocs-table-reader-plugin) (📥 59K / month): ``` pip install mkdocs-table-reader-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - table-reader ```
drawio-exporter - 🥈18 · ⭐ 79 · MIT ·
Exports your Draw.io diagrams at build time for easier embedding into your documentation. - [GitHub](https://github.com/LukeCarrier/mkdocs-drawio-exporter) (👨‍💻 5 · 🔀 9 · 📦 84 · 📋 29 - 17% open · ⏱️ 01.11.2024) - [PyPi](https://pypi.org/project/mkdocs-drawio-exporter) (📥 13K / month): ``` pip install mkdocs-drawio-exporter ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - drawio-exporter ```
MkDocs Video - 🥈17 · ⭐ 68 · MIT ·
MkDocs Video plugin. - [GitHub](https://github.com/soulless-viewer/mkdocs-video) (👨‍💻 5 · 🔀 13 · 📥 62 · 📦 780 · ⏱️ 04.01.2024) - [PyPi](https://pypi.org/project/mkdocs-video) (📥 65K / month): ``` pip install mkdocs-video ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs-video ```
Markdown blockdiag - 🥈17 · ⭐ 28 · MIT ·
blockdiag extension for Python Markdown. - [GitHub](https://github.com/gisce/markdown-blockdiag) (👨‍💻 5 · 🔀 10 · 📦 110 · 📋 6 - 50% open · ⏱️ 22.11.2023) - [PyPi](https://pypi.org/project/markdown-blockdiag) (📥 2.8K / month): ``` pip install markdown-blockdiag ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - markdown_blockdiag ```
mkdocs-d2-plugin - 🥈17 · ⭐ 22 · MIT ·
A plugin for embedding D2 diagrams in MkDocs. - [GitHub](https://github.com/landmaj/mkdocs-d2-plugin) (👨‍💻 3 · 🔀 4 · 📦 10 · 📋 12 - 8% open · ⏱️ 22.08.2024) - [PyPi](https://pypi.org/project/mkdocs-d2-plugin) (📥 49K / month): ``` pip install mkdocs-d2-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - d2 ```
build-plantuml - 🥈16 · ⭐ 59 · MIT ·
MkDocs plugin to help generate your plantuml images locally or remotely as files (NOT inline). - [GitHub](https://github.com/quantorconsulting/mkdocs_build_plantuml) (👨‍💻 11 · 🔀 16 · 📦 120 · 📋 23 - 8% open · ⏱️ 25.03.2024) - [PyPi](https://pypi.org/project/mkdocs-build-plantuml-plugin) (📥 48K / month): ``` pip install mkdocs-build-plantuml-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - build_plantuml ```
Lightgallery - 🥈14 · ⭐ 26 · 💤 · MIT ·
Markdown extension to wrap images in a lightbox. - [GitHub](https://github.com/g-provost/lightgallery-markdown) (👨‍💻 6 · 🔀 4 · 📦 96 · 📋 11 - 54% open · ⏱️ 07.10.2023) - [PyPi](https://pypi.org/project/lightgallery) (📥 4.2K / month): ``` pip install lightgallery ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - lightgallery ```
panzoom - 🥈14 · ⭐ 16 · 🐣 · MIT ·
MkDocs Plugin to enable pan & zoom on images and mermaid/d2 diagrams. - [GitHub](https://github.com/PLAYG0N/mkdocs-panzoom) (👨‍💻 2 · 📥 28 · 📦 7 · 📋 12 - 16% open · ⏱️ 16.10.2024) - [PyPi](https://pypi.org/project/mkdocs-panzoom-plugin) (📥 4.3K / month): ``` pip install mkdocs-panzoom-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - panzoom ```
mkdocs-diagrams - 🥈13 · ⭐ 29 · 💤 · MIT ·
MkDocs plugin to render Diagrams files. - [GitHub](https://github.com/zoni/mkdocs-diagrams) (🔀 3 · 📦 65 · 📋 3 - 33% open · ⏱️ 04.09.2020) - [PyPi](https://pypi.org/project/mkdocs-diagrams) (📥 14K / month): ``` pip install mkdocs-diagrams ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - diagrams ```
markdownmermaid - 🥉12 · ⭐ 26 · 💤 · MIT ·
A MkDocs plugin that support mermaid graph in markdown file. - [GitHub](https://github.com/pugong/mkdocs-mermaid-plugin) (👨‍💻 2 · 🔀 15 · 📦 95 · 📋 6 - 33% open · ⏱️ 26.05.2019) - [PyPi](https://pypi.org/project/mkdocs-mermaid-plugin) (📥 6.1K / month): ``` pip install mkdocs-mermaid-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - markdownmermaid ```
docutools - 🥉11 · ⭐ 24 · 💤 · BSD-2 ·
Dev Centric Tools for Mkdocs Based Documentation. - [GitHub](https://github.com/axiros/docutools) (👨‍💻 3 · 📦 8 · 📋 2 - 50% open · ⏱️ 04.09.2023) - [PyPi](https://pypi.org/project/docutools) (📥 3K / month): ``` pip install docutools ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - lcd-find-pages - lcd-custom-dir - lcd-blacklist - lcd-lp - lcd-md-replace - lcd-page-tree - lcd-stats ```
Termage - 🥉11 · ⭐ 24 · 💤 · MIT ·
Generate SVGs from any Python code, even in your documentation. - [GitHub](https://github.com/bczsalba/Termage) (📦 3 · 📋 5 - 20% open · ⏱️ 23.08.2022) - [PyPi](https://pypi.org/project/Termage) (📥 420 / month): ``` pip install Termage ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - termage ```
MkDocs Img2Fig Plugin - 🥉11 · ⭐ 21 · 💤 · MIT ·
A MkDocs plugin that converts markdown encoded images into figure elements. - [GitHub](https://github.com/stuebersystems/mkdocs-img2fig-plugin) (👨‍💻 2 · 🔀 7 · 📦 120 · 📋 3 - 66% open · ⏱️ 14.07.2020) - [PyPi](https://pypi.org/project/mkdocs-img2fig-plugin) (📥 1.7K / month): ``` pip install mkdocs-img2fig-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - img2fig ```
markdown-captions - 🥉10 · ⭐ 9 · 💤 · ❗️GPL-3.0 ·
Python-Markdown plugin for image captions. - [GitHub](https://github.com/Evidlo/markdown_captions) (👨‍💻 2 · 🔀 5 · 📦 160 · 📋 8 - 12% open · ⏱️ 24.05.2023) - [PyPi](https://pypi.org/project/markdown-captions) (📥 2.5K / month): ``` pip install markdown-captions ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - markdown_captions ```
Interactive Graph - 🥉9 · ⭐ 14 · MIT ·
interactive graph for Material for MkDocs like Obsidian, refer demo:. - [GitHub](https://github.com/daxcore/mkdocs-obsidian-interactive-graph-plugin) (👨‍💻 2 · 🔀 2 · 📦 35 · 📋 3 - 66% open · ⏱️ 24.04.2024) - [PyPi](https://pypi.org/project/mkdocs-obsidian-interactive-graph-plugin) (📥 1.1K / month): ``` pip install mkdocs-obsidian-interactive-graph-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - obsidian-interactive-graph ```
mkdocs-resize-images - 🥉9 · ⭐ 3 · MIT ·
MkDocs plugin to resize images according to the configuration. - [GitHub](https://github.com/JakubAndrysek/mkdocs-resize-images) (📦 10 · ⏱️ 04.11.2023) - [PyPi](https://pypi.org/project/mkdocs-resize-images) (📥 650 / month): ``` pip install mkdocs-resize-images ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - resize-images ```
markdownwavedrom - 🥉8 · ⭐ 9 · 💤 · MPL-2.0 ·
A MkDocs plugin for support wavedrom charts in markdown file. - [GitHub](https://github.com/kuri65536/mkdocs-wavedrom-plugin) (🔀 2 · 📦 14 · 📋 3 - 33% open · ⏱️ 26.06.2021) - [PyPi](https://pypi.org/project/mkdocs-wavedrom-plugin) (📥 340 / month): ``` pip install mkdocs-wavedrom-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - markdownwavedrom ```
svgbob extension for Python Markdown - 🥉8 · ⭐ 7 · MIT ·
svgbob extension for Python Markdown. - [GitHub](https://github.com/mbarkhau/markdown-svgbob) (👨‍💻 2 · 🔀 2 · 📦 10 · 📋 2 - 50% open · ⏱️ 21.06.2024) - [PyPi](https://pypi.org/project/markdown-svgbob) (📥 1.5K / month): ``` pip install markdown-svgbob ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - markdown_svgbob ```
badges - 🥉7 · ⭐ 12 · MIT ·
Add badges to your mkdocs page. - [GitHub](https://github.com/six-two/mkdocs-badges) (🔀 1 · ⏱️ 11.08.2024) - [PyPi](https://pypi.org/project/mkdocs-badges) (📥 3.7K / month): ``` pip install mkdocs-badges ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - badges ```
plotly charts - 🥉7 · ⭐ 10 · 💤 · MIT ·
Mkdocs plugin to add interactive charts with Plotly.js. - [GitHub](https://github.com/haoda-li/mkdocs-plotly-plugin) (👨‍💻 3 · ⏱️ 25.07.2023) - [PyPi](https://pypi.org/project/mkdocs-plotly-plugin) (📥 2.8K / month): ``` pip install mkdocs-plotly-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - plotly ```
Markdown aafigure - 🥉6 · ⭐ 6 · MIT ·
aafigure extension for Python Markdown. - [GitHub](https://github.com/mbarkhau/markdown-aafigure) (👨‍💻 2 · 🔀 1 · 📋 3 - 33% open · ⏱️ 04.05.2024) - [PyPi](https://pypi.org/project/markdown-aafigure) (📥 1.4K / month): ``` pip install markdown-aafigure ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - markdown_aafigure ```
MkDocs Graphviz - 🥉6 · ⭐ 5 · 💤 · ❗Unlicensed ·
A mkdocs Extension that automatically renders Graphviz images, in SVG or PNG format, within your markdown file. - [PyPi](https://pypi.org/project/mkdocs-graphviz) (📥 5.4K / month): ``` pip install mkdocs-graphviz ``` - [GitLab](https://gitlab.com/rod2ik/mkdocs-graphviz) (🔀 1 · 📋 7 - 42% open · ⏱️ 03.05.2021) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mkdocs_graphviz ```
pico-8 - 🥉6 · ⭐ 2 · 💤 · MIT ·
A MKDocs plugin that allows to embed a Pico-8 web player in a page. - [GitHub](https://github.com/fmaida/pico8-mkdocs-plugin) (📦 3 · ⏱️ 17.03.2019) - [PyPi](https://pypi.org/project/pico8-mkdocs-plugin) (📥 72 / month): ``` pip install pico8-mkdocs-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - pico-8 ```
thumbnails - 🥉5 · ⭐ 2 · 💤 · MIT ·
MkDocs plugin for thumbnail images generated automatically. - [GitHub](https://github.com/normanlorrain/mkdocs-thumbnails) (📋 2 - 50% open · ⏱️ 05.06.2023) - [PyPi](https://pypi.org/project/mkdocs-thumbnails) (📥 460 / month): ``` pip install mkdocs-thumbnails ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - thumbnails ```
markdown-figcap - 🥉5 · ⭐ 1 · 💤 · BSD-3 ·
Extension for Python-Markdown to handle figure and figcaption. - [GitHub](https://github.com/funk1d/markdown-figcap) (📦 7 · ⏱️ 09.03.2019) - [PyPi](https://pypi.org/project/markdown-figcap) (📥 130 / month): ``` pip install markdown-figcap ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - markdown_figcap ```
inline-svg - 🥉5 · MIT · - [GitHub](https://github.com/rajguru7/mkdocs-plugin-inline-svg-mod) (👨‍💻 5 · 🔀 1 · 📦 6 · ⏱️ 12.01.2024) - [PyPi](https://pypi.org/project/mkdocs-plugin-inline-svg-mod) (📥 480 / month): ``` pip install mkdocs-plugin-inline-svg-mod ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - inline-svg ```
import-statement - 🥉4 · ⭐ 2 · 💤 · MIT · - [GitHub](https://github.com/Rj40x40/mkdocs-import-statement-plugin) (📦 3 · ⏱️ 06.02.2023) - [PyPi](https://pypi.org/project/mkdocs-import-statement-plugin) (📥 120 / month): ``` pip install mkdocs-import-statement-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - import-statement ```
Family tree example - 🥉4 · ⭐ 2 · 💤 · ❗️GPL-3.0
An interactive family tree visualization using d3-dag. - [GitHub](https://github.com/unverbuggt/mkdocs-familytree-example) (👨‍💻 6 · 🔀 1 · ⏱️ 04.08.2023)
sequence-js - 🥉3 · ⭐ 4 · 💤 · MIT ·
MkDocs plugin to render sequence.js blocks. - [GitHub](https://github.com/fcannizzaro/mkdocs-sequence-js-plugin) (🔀 2 · 📋 3 - 33% open · ⏱️ 28.02.2020) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - sequence-js ```
image-formatter-plugin - 🥉3 · ⭐ 3 · ❗Unlicensed · - [GitHub](https://github.com/ASypula/mkdocs-image-formatter-plugin) (👨‍💻 7 · 📦 2 · ⏱️ 06.12.2023) - [PyPi](https://pypi.org/project/mkdocs-image-formatter-plugin) (📥 88 / month): ``` pip install mkdocs-image-formatter-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - image-formatter ```
MkHack3rs - 🥉2 · ⭐ 4 · 💤 · ❗Unlicensed ·
Hacks & Integrations for Mkdocs / Material Theme. - [GitLab](https://gitlab.com/eskool/mkhack3rs) (🔀 1 · ⏱️ 01.05.2021)


🤖 Code execution, variables & templating

Back to top

macros - 🥇30 · ⭐ 340 · MIT ·
Create richer and more beautiful pages in MkDocs, by using variables and calls to macros in the markdown code. - [GitHub](https://github.com/fralau/mkdocs-macros-plugin) (👨‍💻 34 · 🔀 49 · 📦 4K · ⏱️ 03.11.2024) - [PyPi](https://pypi.org/project/mkdocs-macros-plugin) (📥 520K / month): ``` pip install mkdocs-macros-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - macros ```
mkdocs-jupyter - 🥇24 · ⭐ 400 · Apache-2 ·
Use Jupyter Notebook in mkdocs. - [GitHub](https://github.com/danielfrg/mkdocs-jupyter) (👨‍💻 32 · 🔀 49 · 📦 3K · 📋 130 - 21% open · ⏱️ 15.10.2024) - [PyPi](https://pypi.org/project/mkdocs-jupyter) (📥 150K / month): ``` pip install mkdocs-jupyter ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs-jupyter ```
mknotebooks - 🥈20 · ⭐ 140 · 💤 · MIT ·
A plugin for mkdocs to help you include Jupyter notebooks in your projects. - [GitHub](https://github.com/greenape/mknotebooks) (👨‍💻 14 · 🔀 20 · 📦 610 · 📋 40 - 35% open · ⏱️ 11.08.2023) - [PyPi](https://pypi.org/project/mknotebooks) (📥 34K / month): ``` pip install mknotebooks ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mknotebooks ```
gen-files - 🥈20 · ⭐ 110 · MIT ·
MkDocs plugin to programmatically generate documentation pages during the build. - [GitHub](https://github.com/oprypin/mkdocs-gen-files) (👨‍💻 5 · 🔀 10 · 📦 2.5K · 📋 27 - 29% open · ⏱️ 27.04.2024) - [PyPi](https://pypi.org/project/mkdocs-gen-files) (📥 380K / month): ``` pip install mkdocs-gen-files ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - gen-files ```
markdown-exec - 🥈19 · ⭐ 110 · ISC ·
Utilities to execute code blocks in Markdown files. - [GitHub](https://github.com/pawamoy/markdown-exec) (👨‍💻 2 · 🔀 8 · 📦 350 · 📋 50 - 18% open · ⏱️ 08.07.2024) - [PyPi](https://pypi.org/project/markdown-exec) (📥 47K / month): ``` pip install markdown-exec ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - markdown-exec ```
markdownextradata - 🥈19 · ⭐ 84 · 📉 · MIT ·
A MkDocs plugin that injects the mkdocs.yml extra variables into the markdown template. - [GitHub](https://github.com/rosscdh/mkdocs-markdownextradata-plugin) (👨‍💻 12 · 🔀 17 · 📦 1.3K · 📋 35 - 17% open · ⏱️ 22.08.2024) - [PyPi](https://pypi.org/project/mkdocs-markdownextradata-plugin) (📥 47K / month): ``` pip install mkdocs-markdownextradata-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - markdownextradata ```
mkdocs-markmap - 🥈15 · ⭐ 48 · 💤 · MIT ·
MkDocs plugin and extension to create mindmaps from markdown using markmap. - [GitHub](https://github.com/markmap/mkdocs-markmap) (👨‍💻 3 · 🔀 5 · 📥 320 · 📋 26 - 7% open · ⏱️ 05.10.2023) - [PyPi](https://pypi.org/project/mkdocs-markmap) (📥 2.3K / month): ``` pip install mkdocs-markmap ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - markmap ```
Termynal - 🥈14 · ⭐ 98 · MIT ·
Python markdown terminal. Built for mkdocs. - [GitHub](https://github.com/termynal/termynal.py) (👨‍💻 5 · 🔀 8 · 📦 240 · 📋 16 - 50% open · ⏱️ 01.06.2024) - [PyPi](https://pypi.org/project/termynal) (📥 7.5K / month): ``` pip install termynal ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - termynal ```
pheasant - 🥈14 · ⭐ 16 · MIT ·
Documentation tool for Markdown conversion by Jupyter client. - [GitHub](https://github.com/daizutabi/pheasant) (👨‍💻 4 · 🔀 9 · 📦 52 · ⏱️ 27.09.2024) - [PyPi](https://pypi.org/project/pheasant) (📥 5.3K / month): ``` pip install pheasant ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - pheasant ```
user-defined-values - 🥉12 · ⭐ 4 · 💤 · MIT ·
MkDocs User Defined Values. - [GitHub](https://github.com/rahult/mkdocs-user-defined-values) (👨‍💻 3 · 🔀 3 · 📥 13 · 📦 15 · ⏱️ 10.07.2022) - [PyPi](https://pypi.org/project/mkdocs-user-defined-values) (📥 890 / month): ``` pip install mkdocs-user-defined-values ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - user-defined-values ```
placeholder - 🥉9 · ⭐ 13 · MIT ·
Add placeholders to your MkDocs pages. - [GitHub](https://github.com/six-two/mkdocs-placeholder-plugin) (👨‍💻 2 · 🔀 3 · ⏱️ 20.10.2024) - [PyPi](https://pypi.org/project/mkdocs-placeholder-plugin) (📥 4.7K / month): ``` pip install mkdocs-placeholder-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - placeholder ```
nbconvert - 🥉9 · ⭐ 9 · BSD-2 ·
A MkDocs plug-in provides a source parser for *.ipynb files. - [GitHub](https://github.com/tanbro/mkdocs-nbconvert) (👨‍💻 5 · 🔀 1 · 📦 4 · ⏱️ 21.10.2024) - [PyPi](https://pypi.org/project/mkdocs-nbconvert) (📥 1.4K / month): ``` pip install mkdocs-nbconvert ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - nbconvert ```
markdown-filter - 🥉8 · ⭐ 5 · 💤 · MIT ·
Adds a markdown template filter to the jinja templating environment in mkdocs. - [GitHub](https://github.com/byrnereese/mkdocs-markdown-filter) (🔀 2 · 📦 29 · ⏱️ 06.02.2019) - [PyPi](https://pypi.org/project/mkdocs-markdown-filter) (📥 470 / month): ``` pip install mkdocs-markdown-filter ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - markdown-filter ```
mkjsfiddle - 🥉8 · ⭐ 4 · 💤 · MIT ·
An MkDocs plugin that lets you edit code fences in JSFiddle. - [GitHub](https://github.com/stadiamaps/mkjsfiddle) (📦 2 · ⏱️ 07.06.2023) - [PyPi](https://pypi.org/project/mkjsfiddle) (📥 290 / month): ``` pip install mkjsfiddle ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - jsfiddle ```
meta-manager - 🥉8 · ⭐ 1 · MIT ·
MkDocs plugin for managing meta tags across folders and files. - [GitHub](https://github.com/timmeinerzhagen/mkdocs-meta-manager) (👨‍💻 3 · 🔀 1 · 📦 9 · 📋 3 - 33% open · ⏱️ 09.05.2024) - [PyPi](https://pypi.org/project/mkdocs-meta-manager) (📥 2.6K / month): ``` pip install mkdocs-meta-manager ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - meta-manager ```
Entangled - 🥉7 · ⭐ 2 · 💤 · Apache-2 ·
An MkDocs plugin that lets you do Literate Programming through Entangled. - [GitHub](https://github.com/entangled/mkdocs-plugin) (📦 9 · ⏱️ 14.10.2023) - [PyPi](https://pypi.org/project/mkdocs-entangled-plugin) (📥 280 / month): ``` pip install mkdocs-entangled-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - entangled ```
codeyaml - 🥉6 · 💤 · MIT ·
Allows for more than one yaml config in mkdocs. - [GitHub](https://github.com/textileio/mkdocs-codeyaml-plugin) (🔀 1 · 📦 2 · ⏱️ 30.04.2019) - [PyPi](https://pypi.org/project/mkdocs-codeyaml-plugin) (📥 170 / month): ``` pip install mkdocs-codeyaml-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - codeyaml ```
jinja2sandbox - 🥉5 · ⭐ 4 · 💤 · MIT ·
A MkDocs plugin that enables the Jinja2-sandbox. - [GitHub](https://github.com/rkoe/mkdocs-jinja2sandbox) (⏱️ 20.03.2019) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - jinja2sandbox ```
mkdocs_protobuf - 🥉4 · ⭐ 2 · 💤 · Apache-2 ·
Mkdocs plugin to render protobuf messages. - [GitHub](https://github.com/rymurr/mkdocs-protobuf) (👨‍💻 2 · 🔀 1 · ⏱️ 30.03.2022) - [PyPi](https://pypi.org/project/mkdocs-protobuf) (📥 410 / month): ``` pip install mkdocs-protobuf ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs_protobuf ```


🌲 Git repos & info

Back to top

git-revision-date-localized - 🥇30 · ⭐ 210 · 📈 · MIT ·
MkDocs plugin to add a last updated date to your site pages. - [GitHub](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) (👨‍💻 29 · 🔀 42 · 📦 7.9K · 📋 97 - 10% open · ⏱️ 22.10.2024) - [PyPi](https://pypi.org/project/mkdocs-git-revision-date-localized-plugin) (📥 540K / month): ``` pip install mkdocs-git-revision-date-localized-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - git-revision-date-localized ```
git-authors - 🥈25 · ⭐ 86 · 📈 · MIT ·
MkDocs plugin to display git authors of a page. - [GitHub](https://github.com/timvink/mkdocs-git-authors-plugin) (👨‍💻 14 · 🔀 19 · 📦 1.1K · 📋 61 - 19% open · ⏱️ 26.10.2024) - [PyPi](https://pypi.org/project/mkdocs-git-authors-plugin) (📥 110K / month): ``` pip install mkdocs-git-authors-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - git-authors ```
git-committers-2 - 🥈24 · ⭐ 60 · MIT ·
An MkDocs plugin to create a list of contributors on the page. - [GitHub](https://github.com/ojacques/mkdocs-git-committers-plugin-2) (👨‍💻 17 · 🔀 21 · 📦 770 · 📋 41 - 24% open · ⏱️ 24.10.2024) - [PyPi](https://pypi.org/project/mkdocs-git-committers-plugin-2) (📥 63K / month): ``` pip install mkdocs-git-committers-plugin-2 ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - git-committers ```
git-revision-date - 🥈20 · ⭐ 56 · 💤 · MIT ·
MkDocs plugin for setting revision date from git per markdown file. - [GitHub](https://github.com/zhaoterryy/mkdocs-git-revision-date-plugin) (👨‍💻 7 · 🔀 8 · 📦 2.4K · 📋 14 - 35% open · ⏱️ 08.03.2022) - [PyPi](https://pypi.org/project/mkdocs-git-revision-date-plugin) (📥 84K / month): ``` pip install mkdocs-git-revision-date-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - git-revision-date ```
git-committers - 🥉15 · ⭐ 41 · MIT ·
A mkdocs plugin for displaying the last commit and a list of a files contributors. - [GitHub](https://github.com/byrnereese/mkdocs-git-committers-plugin) (👨‍💻 6 · 🔀 7 · 📦 230 · 📋 8 - 87% open · ⏱️ 06.11.2023) - [PyPi](https://pypi.org/project/mkdocs-git-committers-plugin) (📥 25K / month): ``` pip install mkdocs-git-committers-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - git-committers ```
Github-Links - 🥉8 · ⭐ 10 · ❗Unlicensed ·
Python-Markdown GitHub Links Extension. - [GitHub](https://github.com/Python-Markdown/github-links) (👨‍💻 4 · 🔀 9 · ⏱️ 22.12.2023) - [PyPi](https://pypi.org/project/mdx-gh-links) (📥 7.8K / month): ``` pip install mdx-gh-links ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mdx_gh_links ```
branchcustomization - 🥉8 · ⭐ 2 · 💤 · MIT ·
Customize MkDocs options on a per-branch basis. - [GitHub](https://github.com/effigies/mkdocs-branchcustomization-plugin) (📦 17 · ⏱️ 17.04.2022) - [PyPi](https://pypi.org/project/mkdocs-branchcustomization-plugin) (📥 1.2K / month): ``` pip install mkdocs-branchcustomization-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - branchcustomization ```
mkdocs-git-latest-changes-plugin - 🥉8 · ⭐ 1 · MIT ·
MkDocs plugin that allows you to display a list of recently modified pages from the Git log. - [GitHub](https://github.com/tombreit/mkdocs-git-latest-changes-plugin) (👨‍💻 2 · 🔀 2 · 📦 5 · 📋 13 - 7% open · ⏱️ 16.10.2024) - [PyPi](https://pypi.org/project/mkdocs-git-latest-changes-plugin) (📥 920 / month): ``` pip install mkdocs-git-latest-changes-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - git-latest-changes ```
Github Releaase Changelog - 🥉6 · ⭐ 4 · MIT ·
mkdocs extension to autogenerate changelog from github releases. - [GitHub](https://github.com/djpugh/mkdocs_github_changelog) (👨‍💻 2 · ⏱️ 02.01.2024) - [PyPi](https://pypi.org/project/mkdocs-github-changelog) (📥 200 / month): ``` pip install mkdocs-github-changelog ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs_github_changelog ```
git-latest-release - 🥉4 · ⭐ 1 · 💤 · ❗️GPL-3.0 ·
Plugin for MKDocs to inject the latest release tag from git into markdown. - [GitHub](https://github.com/agarthetiger/mkdocs_latest_release_plugin) (👨‍💻 3 · ⏱️ 29.12.2019) - [PyPi](https://pypi.org/project/mkdocs-latest-release-plugin) (📥 890 / month): ``` pip install mkdocs-latest-release-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - git-latest-release ```


🌈 HTML processing & CSS styling

Back to top

minify - 🥇22 · ⭐ 150 · MIT ·
A mkdocs plugin to minify the HTML of a page before it is written to disk. - [GitHub](https://github.com/byrnereese/mkdocs-minify-plugin) (👨‍💻 14 · 🔀 18 · 📦 8.5K · 📋 17 - 23% open · ⏱️ 29.01.2024) - [PyPi](https://pypi.org/project/mkdocs-minify-plugin) (📥 200K / month): ``` pip install mkdocs-minify-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - minify ```
enumerate-headings - 🥇19 · ⭐ 41 · MIT ·
MkDocs Plugin to enumerate the headings across site pages. - [GitHub](https://github.com/timvink/mkdocs-enumerate-headings-plugin) (👨‍💻 5 · 🔀 9 · 📦 240 · 📋 32 - 12% open · ⏱️ 16.04.2024) - [PyPi](https://pypi.org/project/mkdocs-enumerate-headings-plugin) (📥 24K / month): ``` pip install mkdocs-enumerate-headings-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - enumerate-headings ```
minify-html - 🥈17 · ⭐ 7 · MIT ·
MkDocs plugin for minification using minify-html, an extremely fast and smart HTML + JS + CSS minifier. - [GitHub](https://github.com/monosans/mkdocs-minify-html-plugin) (👨‍💻 4 · 📦 26 · ⏱️ 02.11.2024) - [PyPi](https://pypi.org/project/mkdocs-minify-html-plugin) (📥 23K / month): ``` pip install mkdocs-minify-html-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - minify_html ```
Publisher for MkDocs - social - 🥈16 · ⭐ 61 · MIT ·
Social media sharing helper. - [GitHub](https://github.com/mkdocs-publisher/mkdocs-publisher) (👨‍💻 2 · 🔀 2 · 📥 54 · 📦 61 · 📋 21 - 28% open · ⏱️ 11.08.2024) - [PyPi](https://pypi.org/project/mkdocs-publisher) (📥 2.6K / month): ``` pip install mkdocs-publisher ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - pub-social ```
Publisher for MkDocs - minifier - 🥈16 · ⭐ 61 · MIT ·
Size optimization (minification) for HTML, CSS, JS, SVG, PNG and JPEG files. - [GitHub](https://github.com/mkdocs-publisher/mkdocs-publisher) (👨‍💻 2 · 🔀 2 · 📥 54 · 📦 61 · 📋 21 - 28% open · ⏱️ 11.08.2024) - [PyPi](https://pypi.org/project/mkdocs-publisher) (📥 2.6K / month): ``` pip install mkdocs-publisher ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - pub-minifier ```
mkdocs-link-embeds - 🥈13 · ⭐ 6 · MIT ·
Mkdocs plugin which displays links in a more elegant way. Links will automatically be populated with an image,.. - [GitHub](https://github.com/Aetherinox/mkdocs-link-embeds) (📥 23 · 📦 8 · ⏱️ 25.10.2024) - [PyPi](https://pypi.org/project/mkdocs-link-embeds-plugin) (📥 770 / month): ``` pip install mkdocs-link-embeds-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - link-embeds ```
mkdocs_safe_text - 🥈13 · ⭐ 3 · BSD-2 ·
Plugin for safe text editing with MKDocs. - [GitHub](https://github.com/raimon49/mkdocs-safe-text-plugin) (👨‍💻 2 · 📦 9 · ⏱️ 22.07.2024) - [PyPi](https://pypi.org/project/mkdocs-safe-text-plugin) (📥 1.4K / month): ``` pip install mkdocs-safe-text-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs_safe_text ```
add-number - 🥉12 · ⭐ 16 · 💤 · MIT ·
MkDocs plugin to automatically number the headings (h1-h6) in each markdown page and the nav. - [GitHub](https://github.com/ignorantshr/mkdocs-add-number-plugin) (👨‍💻 3 · 🔀 3 · 📦 47 · 📋 11 - 18% open · ⏱️ 11.06.2020) - [PyPi](https://pypi.org/project/mkdocs-add-number-plugin) (📥 6.6K / month): ``` pip install mkdocs-add-number-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - add-number ```
mkdocs-extra-sass-plugin - 🥉12 · ⭐ 3 · 💤 · MIT ·
Adds stylesheets to your mkdocs site from Sass/SCSS. - [GitHub](https://github.com/orzih/mkdocs-extra-sass-plugin) (🔀 3 · 📦 51 · ⏱️ 13.02.2021) - [PyPi](https://pypi.org/project/mkdocs-extra-sass-plugin) (📥 7.2K / month): ``` pip install mkdocs-extra-sass-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - extra-sass ```
bootstrap-tables - 🥉9 · ⭐ 12 · 💤 · MIT ·
A MkDocs plugin to add bootstrap classes to plan markdown generated tables. - [GitHub](https://github.com/byrnereese/mkdocs-bootstrap-tables-plugin) (🔀 2 · 📦 85 · ⏱️ 27.03.2020) - [PyPi](https://pypi.org/project/mkdocs-bootstrap-tables-plugin) (📥 1.4K / month): ``` pip install mkdocs-bootstrap-tables-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - bootstrap-tables ```
mkdocs-add-teaser - 🥉9 · ⭐ 4 · 💤 · MIT ·
An MkDocs plugin to customize the first paragraph of your pages, and to use it as the pages meta description. - [GitHub](https://github.com/wilhelmer/mkdocs-add-teaser) (👨‍💻 3 · 🔀 1 · 📦 5 · ⏱️ 08.11.2022) - [PyPi](https://pypi.org/project/mkdocs-add-teaser) (📥 750 / month): ``` pip install mkdocs-add-teaser ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs-add-teaser ```
toggle-sidebar - 🥉8 · ⭐ 5 · MIT ·
Toggle the navigation and/or TOC sidebars on your MkDocs site. - [GitHub](https://github.com/six-two/mkdocs-toggle-sidebar-plugin) (⏱️ 10.09.2024) - [PyPi](https://pypi.org/project/mkdocs-toggle-sidebar-plugin) (📥 1K / month): ``` pip install mkdocs-toggle-sidebar-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - toggle-sidebar ```
MkDocs Pygments - 🥉5 · ⭐ 6 · 🐣 · ISC ·
Highlighting themes for code blocks. Available to sponsors only. - [GitHub](https://github.com/pawamoy/mkdocs-pygments) (🔀 1 · 📦 2 · ⏱️ 24.05.2024) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - pygments ```
docstyler - 🥉4 · 💤 · BSD-3 ·
Plugin to add alternative stylesheets to MkDocs custom themes. - [GitHub](https://github.com/hfagerlund/mkdocs-docstyler-plugin) (⏱️ 16.02.2019) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - docstyler ```


📎 Integrations with other tools

Back to top

MkDocs Swagger UI Tag - 🥇19 · ⭐ 78 · MIT ·
A MkDocs plugin supports adding Swagger UI to the page. - [GitHub](https://github.com/blueswen/mkdocs-swagger-ui-tag) (👨‍💻 4 · 🔀 8 · 📥 45 · 📦 200 · 📋 23 - 26% open · ⏱️ 27.10.2024) - [PyPi](https://pypi.org/project/mkdocs-swagger-ui-tag) (📥 42K / month): ``` pip install mkdocs-swagger-ui-tag ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - swagger-ui-tag ```
mkdocs-coverage - 🥈18 · ⭐ 23 · ISC ·
MkDocs plugin to integrate your coverage HTML report into your site. - [GitHub](https://github.com/pawamoy/mkdocs-coverage) (🔀 1 · 📦 220 · 📋 10 - 40% open · ⏱️ 11.06.2024) - [PyPi](https://pypi.org/project/mkdocs-coverage) (📥 28K / month): ``` pip install mkdocs-coverage ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - coverage ```
Publisher for MkDocs - obsidian - 🥈16 · ⭐ 61 · MIT ·
Obsidian.md integration including with support for wiki links, callouts, backlinks etc. - [GitHub](https://github.com/mkdocs-publisher/mkdocs-publisher) (👨‍💻 2 · 🔀 2 · 📥 54 · 📦 61 · 📋 21 - 28% open · ⏱️ 11.08.2024) - [PyPi](https://pypi.org/project/mkdocs-publisher) (📥 2.6K / month): ``` pip install mkdocs-publisher ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - pub-obsidian ```
mkdocs-render-swagger-plugin - 🥈14 · ⭐ 73 · 📉 · MIT ·
A plugin for MKDocs for rendering swagger & openapi schemas using SwaggerUI. - [GitHub](https://github.com/bharel/mkdocs-render-swagger-plugin) (👨‍💻 8 · 🔀 12 · 📥 6 · 📋 15 - 20% open · ⏱️ 23.09.2024) - [PyPi](https://pypi.org/project/mkdocs-render-swagger-plugin) (📥 60K / month): ``` pip install mkdocs-render-swagger-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - render_swagger ```
MkDocs asciinema-player - 🥉13 · ⭐ 6 · MIT ·
Mkdocs Plugin to include asciinema player in your documentation. - [GitHub](https://github.com/pa-decarvalho/mkdocs-asciinema-player) (👨‍💻 3 · 🔀 1 · 📦 2 · 📋 21 - 19% open · ⏱️ 02.11.2024) - [PyPi](https://pypi.org/project/mkdocs-asciinema-player) (📥 1.5K / month): ``` pip install mkdocs-asciinema-player ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - asciinema-player ```
MkDocs Backend for Foliant - 🥉13 · ⭐ 3 · 💤 · MIT
MkDocs backend for Foliant. - [GitHub](https://github.com/foliant-docs/foliantcontrib.mkdocs) (👨‍💻 5 · 🔀 3 · 📦 33 · ⏱️ 12.12.2022) - [PyPi](https://pypi.org/project/foliantcontrib.mkdocs) (📥 1.2K / month): ``` pip install foliantcontrib.mkdocs ```
swagger - 🥉6 · ⭐ 30 · 💤 · MIT ·
MkDocs plugin for render swagger into docs. - [GitHub](https://github.com/allevo/mkdocs-swagger-plugin) (🔀 6 · 📋 5 - 60% open · ⏱️ 06.10.2019) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - swagger ```
factsheet - 🥉6 · ⭐ 3 · 💤 · MIT ·
Generate overviews from YAML descriptions, intended for micro-services and their deployments. - [GitHub](https://github.com/inuits/mkdocs-factsheet) (👨‍💻 4 · 🔀 1 · ⏱️ 08.02.2023) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - factsheet ```
MkDocs Dependency License Information - 🥉5 · ⭐ 3 · MIT ·
mkdocs extension to visualise package dependencies license information. - [GitHub](https://github.com/djpugh/mkdocs_licenseinfo) (👨‍💻 2 · ⏱️ 02.01.2024) - [PyPi](https://pypi.org/project/mkdocs-licenseinfo) (📥 110 / month): ``` pip install mkdocs-licenseinfo ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs_licenseinfo ```


🌍 Internationalization & localization

Back to top

static-i18n - 🥇21 · ⭐ 230 · MIT ·
MkDocs i18n plugin using static translation markdown files. - [GitHub](https://github.com/ultrabug/mkdocs-static-i18n) (👨‍💻 11 · 🔀 38 · 📦 1.3K · 📋 140 - 14% open · ⏱️ 30.05.2024) - [PyPi](https://pypi.org/project/mkdocs-static-i18n) (📥 47K / month): ``` pip install mkdocs-static-i18n ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - i18n ```
mkdocs-mdpo - 🥉12 · ⭐ 7 · BSD-3 ·
Mkdocs translation plugin using PO files. - [GitHub](https://github.com/mondeja/mkdocs-mdpo-plugin) (👨‍💻 4 · 🔀 5 · 📥 240 · 📋 37 - 35% open · ⏱️ 10.06.2024) - [PyPi](https://pypi.org/project/mkdocs-mdpo-plugin) (📥 1.7K / month): ``` pip install mkdocs-mdpo-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mdpo ```
Mkdocs translations plugin - 🥉2 · ❗Unlicensed ·
Internationalization plugin for mkdocs. - [PyPi](https://pypi.org/project/mkdocs-translations) (📥 74 / month): ``` pip install mkdocs-translations ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - translations ```


🔗 Links & references

Back to top

mkdocs-redirects - 🥇25 · ⭐ 180 · MIT ·
Open source plugin for Mkdocs page redirects. - [GitHub](https://github.com/mkdocs/mkdocs-redirects) (👨‍💻 15 · 🔀 21 · 📦 4.2K · 📋 35 - 25% open · ⏱️ 24.06.2024) - [PyPi](https://pypi.org/project/mkdocs-redirects) (📥 390K / month): ``` pip install mkdocs-redirects ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - redirects ```
bibtex - 🥇22 · ⭐ 75 · ❗️BSD-3-Clause-LBNL ·
A MkDocs plugin for citation management using bibtex. - [GitHub](https://github.com/shyamd/mkdocs-bibtex) (👨‍💻 14 · 🔀 21 · 📦 320 · 📋 44 - 27% open · ⏱️ 01.11.2024) - [PyPi](https://pypi.org/project/mkdocs-bibtex) (📥 35K / month): ``` pip install mkdocs-bibtex ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - bibtex ```
htmlproofer - 🥇21 · ⭐ 43 · MIT ·
A MkDocs plugin that validates URL in rendered html files. - [GitHub](https://github.com/manuzhang/mkdocs-htmlproofer-plugin) (👨‍💻 15 · 🔀 16 · 📦 390 · 📋 36 - 8% open · ⏱️ 23.09.2024) - [PyPi](https://pypi.org/project/mkdocs-htmlproofer-plugin) (📥 37K / month): ``` pip install mkdocs-htmlproofer-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - htmlproofer ```
autorefs - 🥈19 · ⭐ 50 · ISC ·
Automatically link across pages in MkDocs. - [GitHub](https://github.com/mkdocstrings/autorefs) (👨‍💻 8 · 🔀 7 · 📋 23 - 13% open · ⏱️ 01.09.2024) - [PyPi](https://pypi.org/project/mkdocs-autorefs) (📥 1.5M / month): ``` pip install mkdocs-autorefs ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - autorefs ```
autolinks - 🥈17 · ⭐ 79 · 💤 · MIT ·
An MkDocs plugin that automagically generates relative links between markdown pages. - [GitHub](https://github.com/zachhannum/mkdocs-autolinks-plugin) (👨‍💻 10 · 🔀 16 · 📦 500 · 📋 18 - 50% open · ⏱️ 04.08.2023) - [PyPi](https://pypi.org/project/mkdocs-autolinks-plugin) (📥 36K / month): ``` pip install mkdocs-autolinks-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - autolinks ```
mkdocs-open-in-new-tab - 🥈17 · ⭐ 24 · MIT ·
This plugin adds JS to open outgoing links and PDFs in a new tab. - [GitHub](https://github.com/JakubAndrysek/mkdocs-open-in-new-tab) (👨‍💻 2 · 🔀 4 · 📦 300 · 📋 6 - 33% open · ⏱️ 18.10.2024) - [PyPi](https://pypi.org/project/mkdocs-open-in-new-tab) (📥 37K / month): ``` pip install mkdocs-open-in-new-tab ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - open-in-new-tab ```
ezlinks - 🥈14 · ⭐ 34 · 💤 · MIT ·
Plugin for mkdocs which enables easier linking between pages. - [GitHub](https://github.com/orbikm/mkdocs-ezlinks-plugin) (🔀 13 · 📥 190 · 📦 120 · 📋 24 - 41% open · ⏱️ 24.01.2022) - [PyPi](https://pypi.org/project/mkdocs-ezlinks-plugin) (📥 3.6K / month): ``` pip install mkdocs-ezlinks-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - ezlinks ```
mkdocs-alias-plugin - 🥈13 · ⭐ 13 · MIT ·
An MkDocs plugin allowing links to your pages using a custom alias. - [GitHub](https://github.com/EddyLuten/mkdocs-alias-plugin) (👨‍💻 3 · 🔀 3 · 📦 29 · 📋 11 - 27% open · ⏱️ 22.04.2024) - [PyPi](https://pypi.org/project/mkdocs-alias-plugin) (📥 1.8K / month): ``` pip install mkdocs-alias-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - alias ```
roamlinks - 🥈12 · ⭐ 52 · 💤 · MIT ·
An MkDocs plugin that automagically generates relative links between markdown pages. - [GitHub](https://github.com/Jackiexiao/mkdocs-roamlinks-plugin) (👨‍💻 9 · 🔀 15 · ⏱️ 08.06.2023) - [PyPi](https://pypi.org/project/mkdocs-roamlinks-plugin) (📥 11K / month): ``` pip install mkdocs-roamlinks-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - roamlinks ```
Autolink References - 🥉11 · ⭐ 18 · MIT ·
mkdocs plugin to provides GitHub like autolink references in Mkdocs. - [GitHub](https://github.com/theskumar/autolink-references-mkdocs-plugin) (👨‍💻 3 · 🔀 6 · 📦 9 · 📋 4 - 25% open · ⏱️ 28.12.2023) - [PyPi](https://pypi.org/project/autolink-references-mkdocs-plugin) (📥 6.1K / month): ``` pip install autolink-references-mkdocs-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - autolink_references ```
mkdocs-site-urls - 🥉11 · ⭐ 15 · 💤 · MIT ·
A MkDocs plugin that adds support for site-relative `site:` URLs. - [GitHub](https://github.com/OctoPrint/mkdocs-site-urls) (🔀 1 · 📦 20 · 📋 2 - 50% open · ⏱️ 31.07.2023) - [PyPi](https://pypi.org/project/mkdocs-site-urls) (📥 9.5K / month): ``` pip install mkdocs-site-urls ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - site-urls ```
unused-files - 🥉11 · ⭐ 8 · 💤 · MIT ·
An MkDocs plugin to find unused (orphaned) files in your project. - [GitHub](https://github.com/wilhelmer/mkdocs-unused-files) (👨‍💻 2 · 🔀 2 · 📦 23 · 📋 10 - 20% open · ⏱️ 17.07.2023) - [PyPi](https://pypi.org/project/mkdocs-unused-files) (📥 2.6K / month): ``` pip install mkdocs-unused-files ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - unused_files ```
ezglossary - 🥉10 · ⭐ 10 · MIT ·
Glossary support for mkdocs. - [GitHub](https://github.com/realtimeprojects/mkdocs-ezglossary) (👨‍💻 2 · 🔀 1 · 📋 22 - 9% open · ⏱️ 11.10.2024) - [PyPi](https://pypi.org/project/mkdocs-ezglossary-plugin) (📥 8.6K / month): ``` pip install mkdocs-ezglossary-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - ezglossary ```
link-marker - 🥉9 · ⭐ 7 · MIT ·
MkDocs plugin for marking links e.g. external ones or mails. - [GitHub](https://github.com/timmeinerzhagen/mkdocs-link-marker) (👨‍💻 2 · 🔀 1 · 📦 21 · 📋 4 - 50% open · ⏱️ 25.02.2024) - [PyPi](https://pypi.org/project/mkdocs-link-marker) (📥 2.9K / month): ``` pip install mkdocs-link-marker ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - link-marker ```
abs-to-rel - 🥉9 · ⭐ 5 · 💤 · MIT ·
MkDocs plugin for converting absolute links to relative ones. - [GitHub](https://github.com/sander76/mkdocs-abs-rel-plugin) (👨‍💻 2 · 🔀 3 · 📦 28 · ⏱️ 03.03.2020) - [PyPi](https://pypi.org/project/mkdocs-abs-rel-plugin) (📥 3.8K / month): ``` pip install mkdocs-abs-rel-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - abs-to-rel ```
Wikilink Plus - 🥉8 · ⭐ 16 · 💤 · ❗Unlicensed ·
A wikilink extension for Python Markdown. - [GitHub](https://github.com/neurobin/mdx_wikilink_plus) (👨‍💻 5 · 🔀 4 · ⏱️ 26.07.2022) - [PyPi](https://pypi.org/project/mdx-wikilink-plus) (📥 4.5K / month): ``` pip install mdx-wikilink-plus ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mdx_wikilink_plus ```
tooltipster-links - 🥉8 · ⭐ 8 · 💤 · MIT ·
An MkDocs plugin that adds tooltips to preview the content of page links using tooltipster. - [GitHub](https://github.com/zachhannum/mkdocs-tooltipster-links-plugin) (🔀 1 · 📦 26 · ⏱️ 29.07.2020) - [PyPi](https://pypi.org/project/mkdocs-tooltipster-links-plugin) (📥 120 / month): ``` pip install mkdocs-tooltipster-links-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - tooltipster-links ```
ArgRef - 🥉8 · ⭐ 1 · 🐣 · ❗Unlicensed ·
mkdocs plugin to provides GitHub like autolink references in Mkdocs. - [GitHub](https://github.com/rhshadrach/mkdocs-argref-plugin) (👨‍💻 5 · 🔀 1 · ⏱️ 25.08.2024) - [PyPi](https://pypi.org/project/mkdocs-argref-plugin) (📥 2.1K / month): ``` pip install mkdocs-argref-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - argref ```
webcontext - 🥉6 · ⭐ 1 · 💤 · MIT ·
Mkdocs plugin for converting absolute paths to webcontext aware paths using the configured webcontext context. - [GitHub](https://github.com/Darrelk/mkdocs-webcontext-plugin) (👨‍💻 2 · 🔀 1 · 📥 11 · 📦 6 · ⏱️ 25.05.2023) - [PyPi](https://pypi.org/project/mkdocs-webcontext-plugin) (📥 200 / month): ``` pip install mkdocs-webcontext-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - webcontext ```
mkdocs-issues-plugin - 🥉5 · ⭐ 1 · 🐣 · MIT ·
A plugin for showing the state and labels of issues, PRs and discussions (GitHub or GitLab) in mkdocs generated docs. - [GitHub](https://github.com/mihaigalos/mkdocs-issues-plugin) (👨‍💻 3 · 📦 1 · ⏱️ 24.07.2024) - [PyPi](https://pypi.org/project/mkdocs-issues-plugin) (📥 680 / month): ``` pip install mkdocs-issues-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs-issues-plugin ```
emailprotect - 🥉4 · ⭐ 5 · 💤 · MIT ·
A MkDocs plugin that tries to obscure email-addresses from address-harvesting spam-bots. - [GitHub](https://github.com/rkoe/mkdocs-emailprotect) (⏱️ 21.01.2020) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - emailprotect ```
Mkdocs-Addresses - 🥉4 · 💤 · ❗Unlicensed ·
Mkdocs plugin, building automatically the appropriate relative paths (to images, links, anchors, ...) using.. - [PyPi](https://pypi.org/project/mkdocs-addresses) (📥 850 / month): ``` pip install mkdocs-addresses ``` - [GitLab](https://gitlab.com/frederic-zinelli/mkdocs-addresses) (🔀 0 · ⏱️ 13.07.2023) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs-addresses ```
alternate-link - 🥉3 · ⭐ 4 · 💤 · MIT ·
An MkDocs plugin that simplifies internal links creation. - [GitHub](https://github.com/cmitu/mkdocs-altlink-plugin) (👨‍💻 3 · 🔀 2 · ⏱️ 14.02.2021) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - alternate-link ```


🧩 Markdown extensions

Back to top

PyMdown Extensions - 🥇32 · ⭐ 960 · ❗Unlicensed ·
Extensions for Python Markdown. - [GitHub](https://github.com/facelessuser/pymdown-extensions) (👨‍💻 47 · 🔀 250 · 📦 38K · 📋 380 - 3% open · ⏱️ 28.10.2024) - [PyPi](https://pypi.org/project/pymdown-extensions) (📥 6.1M / month): ``` pip install pymdown-extensions ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - pymdownx.arithmatex - pymdownx.b64 - pymdownx.betterem - pymdownx.blocks.admonition - pymdownx.blocks.definition - pymdownx.blocks.details - pymdownx.blocks.html - pymdownx.blocks.tab - pymdownx.caret - pymdownx.critic - pymdownx.details - pymdownx.emoji - pymdownx.escapeall - pymdownx.extra - pymdownx.highlight - pymdownx.inlinehilite - pymdownx.keys - pymdownx.magiclink - pymdownx.mark - pymdownx.pathconverter - pymdownx.progressbar - pymdownx.saneheaders - pymdownx.smartsymbols - pymdownx.snippets - pymdownx.striphtml - pymdownx.superfences - pymdownx.tabbed - pymdownx.tasklist - pymdownx.tilde ```
mkdocs-callouts - 🥇18 · ⭐ 29 · MIT ·
A simple MkDocs plugin that converts Obsidian callout blocks to mkdocs supported Admonitions. - [GitHub](https://github.com/sondregronas/mkdocs-callouts) (👨‍💻 2 · 🔀 1 · 📦 1.2K · ⏱️ 12.08.2024) - [PyPi](https://pypi.org/project/mkdocs-callouts) (📥 17K / month): ``` pip install mkdocs-callouts ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - callouts ```
markdown-callouts - 🥇18 · ⭐ 28 · MIT ·
Markdown extension: a classier syntax for admonitions. - [GitHub](https://github.com/oprypin/markdown-callouts) (🔀 12 · 📦 320 · 📋 12 - 33% open · ⏱️ 03.02.2024) - [PyPi](https://pypi.org/project/markdown-callouts) (📥 45K / month): ``` pip install markdown-callouts ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - callouts - github-callouts ```
YAML metadata - 🥈17 · ⭐ 23 · MIT ·
YAML metadata extension for Python-Markdown. - [GitHub](https://github.com/sivakov512/python-markdown-full-yaml-metadata) (👨‍💻 7 · 🔀 4 · 📦 87 · 📋 10 - 30% open · ⏱️ 03.07.2024) - [PyPi](https://pypi.org/project/markdown-full-yaml-metadata) (📥 1.8K / month): ``` pip install markdown-full-yaml-metadata ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - full_yaml_metadata ```
Math extension - 🥈15 · ⭐ 120 · 💤 · BSD-3 ·
Math extension for Python-Markdown. - [GitHub](https://github.com/mitya57/python-markdown-math) (👨‍💻 8 · 🔀 25 · 📋 24 - 8% open · ⏱️ 12.08.2022) - [PyPi](https://pypi.org/project/python-markdown-math) (📥 100K / month): ``` pip install python-markdown-math ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mdx_math ```
Mdx Truly Sane Lists - 🥈15 · ⭐ 84 · 💤 · MIT ·
Extension for Python-Markdown that makes lists truly sane. Custom indents for nested lists and fix for messy.. - [GitHub](https://github.com/radude/mdx_truly_sane_lists) (👨‍💻 4 · 🔀 10 · 📋 15 - 46% open · ⏱️ 19.07.2022) - [PyPi](https://pypi.org/project/mdx-truly-sane-lists) (📥 530K / month): ``` pip install mdx-truly-sane-lists ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mdx_truly_sane_lists ```
Markdown Inline Graphviz - 🥈13 · ⭐ 5 · MIT ·
Render inline graphs with Markdown and Graphviz. - [GitHub](https://github.com/cesaremorel/markdown-inline-graphviz) (👨‍💻 9 · 🔀 8 · 📋 8 - 12% open · ⏱️ 16.01.2024) - [PyPi](https://pypi.org/project/markdown-inline-graphviz-extension) (📥 210K / month): ``` pip install markdown-inline-graphviz-extension ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - markdown_inline_graphviz ```
MarkdownSuperscript - 🥈12 · ⭐ 2 · 💤 · BSD-2 ·
An extension to the Python Markdown package enabling superscript text. - [GitHub](https://github.com/jambonrose/markdown_superscript_extension) (👨‍💻 2 · 🔀 3 · 📦 46 · 📋 4 - 25% open · ⏱️ 02.12.2018) - [PyPi](https://pypi.org/project/MarkdownSuperscript) (📥 1.4K / month): ``` pip install MarkdownSuperscript ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - superscript ```
Markdown Checklist - 🥈11 · ⭐ 79 · 💤 · MIT ·
Python Markdown extension for lists of tasks with checkboxes. - [GitHub](https://github.com/FND/markdown-checklist) (👨‍💻 2 · 🔀 31 · 📋 8 - 12% open · ⏱️ 29.07.2022) - [PyPi](https://pypi.org/project/markdown-checklist) (📥 3.1K / month): ``` pip install markdown-checklist ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - markdown_checklist.extension ```
MarkdownSubscript - 🥈11 · ⭐ 3 · 💤 · BSD-2 ·
An extension to the Python Markdown package enabling subscript text. - [GitHub](https://github.com/jambonrose/markdown_subscript_extension) (👨‍💻 2 · 🔀 1 · 📦 58 · 📋 5 - 40% open · ⏱️ 02.12.2018) - [PyPi](https://pypi.org/project/MarkdownSubscript) (📥 660 / month): ``` pip install MarkdownSubscript ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - subscript ```
python-asciimathml - 🥈10 · ⭐ 4 · 💤 · ❗️GPL-3.0 ·
python ASCIIMathML to Presentation MathML translator. - [GitHub](https://github.com/ShadowKyogre/python-asciimathml) (👨‍💻 8 · 🔀 4 · ⏱️ 04.04.2017) - [PyPi](https://pypi.org/project/asciimathml) (📥 17K / month): ``` pip install asciimathml ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mdx_asciimathml ```
Breakless Lists - 🥉9 · ⭐ 6 · 💤 · MIT ·
Python markdown breakless lists extension. - [GitHub](https://github.com/adamb70/mdx-breakless-lists) (🔀 2 · 📋 2 - 50% open · ⏱️ 08.10.2020) - [PyPi](https://pypi.org/project/mdx-breakless-lists) (📥 31K / month): ``` pip install mdx-breakless-lists ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mdx_breakless_lists ```
markdown-icons - 🥉8 · ⭐ 13 · 💤 · ❗Unlicensed ·
Easily display icon fonts in markdown. - [GitHub](https://github.com/MadLittleMods/markdown-icons) (👨‍💻 4 · 🔀 12 · 📋 7 - 42% open · ⏱️ 09.12.2018) - [PyPi](https://pypi.org/project/markdown-iconfonts) (📥 200 / month): ``` pip install markdown-iconfonts ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - iconfonts ```
markdown-emdash - 🥉8 · ⭐ 3 · 💤 · MIT ·
Emdash extension for python-markdown. - [GitHub](https://github.com/czue/markdown-emdash) (🔀 1 · 📦 35 · ⏱️ 18.05.2023) - [PyPi](https://pypi.org/project/markdown-emdash) (📥 460 / month): ``` pip install markdown-emdash ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mdx_emdash ```
Tweetable quotes - 🥉7 · ⭐ 15 · 💤 · MIT ·
Python-Markdown extension to embed tweetable quotes into your blog posts. - [GitHub](https://github.com/max-arnold/markdown-tweetable) (🔀 1 · 📦 4 · ⏱️ 25.03.2019) - [PyPi](https://pypi.org/project/markdown-tweetable) (📥 350 / month): ``` pip install markdown-tweetable ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - tweetable.extension ```
caption - 🥉7 · ⭐ 9 · 💤 · ❗️GPL-3.0 · - [GitHub](https://github.com/flywire/caption) (👨‍💻 3 · 🔀 2 · 📦 61 · 📋 8 - 87% open · ⏱️ 29.01.2023) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - caption - image_captions - table_captions ```
mkpatcher - 🥉7 · ⭐ 2 · 💤 · Apache-2 ·
Python-Markdown extension allowing arbitrary scripts to modify MkDocs input files. - [GitHub](https://github.com/ofek/mkpatcher) (📦 8 · ⏱️ 26.04.2020) - [PyPi](https://pypi.org/project/mkpatcher) (📥 620 / month): ``` pip install mkpatcher ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mkpatcher ```
Markdown PyCon - 🥉7 · ISC ·
Markdown extension to parse `pycon` code blocks without indentation or fences. - [GitHub](https://github.com/pawamoy/markdown-pycon) (📦 2 · ⏱️ 12.10.2024) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - pycon ```
HEARTBEATS Flavored Markdown - 🥉6 · ⭐ 15 · 💤 · ❗Unlicensed ·
HEARTBEATS Flavored Markdown extension. - [GitHub](https://github.com/heartbeatsjp/markdown-extension-hbfm) (👨‍💻 2 · 🔀 1 · 📦 10 · ⏱️ 01.03.2018) - [PyPi](https://pypi.org/project/hbfm) (📥 360 / month): ``` pip install hbfm ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - hbfm.inline_coloring - hbfm.inline_list - hbfm.number_headers - hbfm.quote_uri_hash ```
markdown-katex - 🥉6 · ⭐ 11 · 💤 · ❗Unlicensed ·
KaTeX extension for Python Markdown. - [PyPi](https://pypi.org/project/markdown-katex) (📥 7.6K / month): ``` pip install markdown-katex ``` - [GitLab](https://gitlab.com/mbarkhau/markdown-katex) (🔀 5 · 📋 17 - 23% open · ⏱️ 14.05.2019) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - markdown_katex ```
KBD Extension - 🥉6 · ⭐ 2 · 💤 · MIT ·
KBD Extension for Python-Markdown. - [GitHub](https://github.com/RickTalken/kbdextension) (🔀 1 · 📦 9 · ⏱️ 08.06.2020) - [PyPi](https://pypi.org/project/kbdextension) (📥 1.6K / month): ``` pip install kbdextension ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - kbdextension ```
Cite Extension - 🥉5 · ⭐ 6 · 💤 · ❗Unlicensed ·
Python-Markdown extension to support the cite tag. - [GitHub](https://github.com/aleray/mdx_cite) (🔀 3 · ⏱️ 21.04.2012) - [PyPi](https://pypi.org/project/mdx-cite) (📥 50 / month): ``` pip install mdx-cite ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mdx_cite ```
markdown_sub_sup - 🥉5 · ⭐ 1 · 💤 · ❗️LGPL-3.0 ·
A python markdown extension for add sub and sup support. - [GitHub](https://github.com/alberic89/markdown_sub_sup) (⏱️ 24.03.2023) - [PyPi](https://pypi.org/project/markdown-sub-sup) (📥 190 / month): ``` pip install markdown-sub-sup ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - markdown_sub_sup ```
Markdown Grid Tables - 🥉5 · ⭐ 1 · 💤 · ❗Unlicensed ·
[Python-Markdown](https://python-markdown.github.io/) [extension](https://python-markdown.github.io/extensions/api/).. - [PyPi](https://pypi.org/project/markdown-grid-tables) (📥 4.5K / month): ``` pip install markdown-grid-tables ``` - [GitLab](https://gitlab.com/WillDaSilva/markdown_grid_tables) (🔀 4 · ⏱️ 09.02.2022) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - markdown_grid_tables ```
markdown-del-ins - 🥉3 · ⭐ 12 · 💤 · ❗Unlicensed ·
Markdown extension to support the del and ins tags. - [GitHub](https://github.com/honzajavorek/markdown-del-ins) (👨‍💻 2 · ⏱️ 09.01.2020) - [PyPi](https://pypi.org/project/markdown-del-ins) (📥 920 / month): ``` pip install markdown-del-ins ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - markdown_del_ins ```
Semantic WikiLinks Extension - 🥉3 · ⭐ 8 · 💤 · ❗Unlicensed ·
Python-Markdown extension to add support for semantic (wiki)links (RDFa). - [GitHub](https://github.com/aleray/mdx_semanticwikilinks) (🔀 1 · ⏱️ 15.08.2012) - [PyPi](https://pypi.org/project/mdx-semanticwikilinks) (📥 130 / month): ``` pip install mdx-semanticwikilinks ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mdx_semanticwikilinks ```
Semantic Data Extension - 🥉3 · ⭐ 5 · 💤 · ❗Unlicensed ·
Python-Markdown extension to add support for semantic data (RDFa). - [GitHub](https://github.com/aleray/mdx_semanticdata) (🔀 1 · ⏱️ 05.11.2012) - [PyPi](https://pypi.org/project/mdx-semanticdata) (📥 89 / month): ``` pip install mdx-semanticdata ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mdx_semanticdata ```
Django Static Image - 🥉1 · ❗Unlicensed · - [PyPi](https://pypi.org/project/markdown-djangostaticimage) (📥 47 / month): ``` pip install markdown-djangostaticimage ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - django_static_image ```


🧭 Navigation & page building

Back to top

awesome-pages - 🥇25 · ⭐ 480 · MIT ·
An MkDocs plugin that simplifies configuring page titles and their order. - [GitHub](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin) (👨‍💻 8 · 🔀 37 · 📦 4.7K · 📋 89 - 25% open · ⏱️ 28.07.2024) - [PyPi](https://pypi.org/project/mkdocs-awesome-pages-plugin) (📥 340K / month): ``` pip install mkdocs-awesome-pages-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - awesome-pages ```
encryptcontent - 🥇22 · ⭐ 130 · MIT ·
A MkDocs plugin that encrypt/decrypt markdown content with AES. - [GitHub](https://github.com/unverbuggt/mkdocs-encryptcontent-plugin) (👨‍💻 6 · 🔀 16 · 📥 92 · 📦 1.1K · 📋 67 - 5% open · ⏱️ 27.10.2024) - [PyPi](https://pypi.org/project/mkdocs-encryptcontent-plugin) (📥 8.8K / month): ``` pip install mkdocs-encryptcontent-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - encryptcontent ```
section-index - 🥇20 · ⭐ 77 · MIT ·
MkDocs plugin to allow clickable sections that lead to an index page. - [GitHub](https://github.com/oprypin/mkdocs-section-index) (👨‍💻 3 · 🔀 8 · 📦 1.8K · 📋 20 - 35% open · ⏱️ 20.04.2024) - [PyPi](https://pypi.org/project/mkdocs-section-index) (📥 220K / month): ``` pip install mkdocs-section-index ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - section-index ```
literate-nav - 🥇20 · ⭐ 76 · MIT ·
MkDocs plugin to specify the navigation in Markdown instead of YAML. - [GitHub](https://github.com/oprypin/mkdocs-literate-nav) (🔀 8 · 📦 2.1K · 📋 30 - 46% open · ⏱️ 27.04.2024) - [PyPi](https://pypi.org/project/mkdocs-literate-nav) (📥 280K / month): ``` pip install mkdocs-literate-nav ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - literate-nav ```
mkdocs-simple-hooks - 🥈18 · ⭐ 59 · MIT ·
Define your own hooks for mkdocs, without having to create a new package. - [GitHub](https://github.com/aklajnert/mkdocs-simple-hooks) (👨‍💻 6 · 🔀 5 · 📥 55 · 📦 1.8K · ⏱️ 14.11.2023) - [PyPi](https://pypi.org/project/mkdocs-simple-hooks) (📥 38K / month): ``` pip install mkdocs-simple-hooks ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs-simple-hooks ```
mkdocs-gallery - 🥈18 · ⭐ 38 · BSD-3 ·
Same features as sphinx-gallery (https://sphinx-gallery.github.io/) but on mkdocs (https://www.mkdocs.org/) (no sphinx.. - [GitHub](https://github.com/smarie/mkdocs-gallery) (👨‍💻 10 · 🔀 16 · 📋 71 - 38% open · ⏱️ 30.09.2024) - [PyPi](https://pypi.org/project/mkdocs-gallery) (📥 5.3K / month): ``` pip install mkdocs-gallery ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - gallery ```
exclude - 🥈17 · ⭐ 86 · 💤 · Apache-2 ·
A mkdocs plugin that lets you exclude files or trees from your output. - [GitHub](https://github.com/apenwarr/mkdocs-exclude) (🔀 10 · 📦 2.2K · 📋 12 - 75% open · ⏱️ 20.02.2019) - [PyPi](https://pypi.org/project/mkdocs-exclude) (📥 170K / month): ``` pip install mkdocs-exclude ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - exclude ```
Publisher for MkDocs - meta - 🥈16 · ⭐ 61 · MIT ·
Automatic navigation based on files metadata with URL name and publication status control. - [GitHub](https://github.com/mkdocs-publisher/mkdocs-publisher) (👨‍💻 2 · 🔀 2 · 📥 54 · 📦 61 · 📋 21 - 28% open · ⏱️ 11.08.2024) - [PyPi](https://pypi.org/project/mkdocs-publisher) (📥 2.6K / month): ``` pip install mkdocs-publisher ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - pub-meta ```
file-filter - 🥈15 · ⭐ 8 · MIT ·
A MkDocs plugin that lets you exclude/include docs files using globs, regexes, gitignore-style file and.. - [GitHub](https://github.com/DariuszPorowski/mkdocs-file-filter-plugin) (👨‍💻 4 · 🔀 3 · 📥 98 · 📦 14 · 📋 12 - 33% open · ⏱️ 19.07.2024) - [PyPi](https://pypi.org/project/mkdocs-file-filter-plugin) (📥 5.8K / month): ``` pip install mkdocs-file-filter-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - file-filter ```
mkdocs-nav-weight - 🥈13 · ⭐ 10 · MIT ·
A simple mkdocs plugin, enables to organize Navigation in a more markdownic way. - [GitHub](https://github.com/shu307/mkdocs-nav-weight) (👨‍💻 3 · 🔀 2 · 📦 72 · ⏱️ 26.10.2024) - [PyPi](https://pypi.org/project/mkdocs-nav-weight) (📥 11K / month): ``` pip install mkdocs-nav-weight ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs-nav-weight ```
MkRefs - 🥈11 · ⭐ 34 · 💤 · MIT ·
MkDocs plugin to generate semantic reference Markdown pages from a knowledge graph. - [GitHub](https://github.com/DerwenAI/mkrefs) (👨‍💻 2 · 📦 5 · ⏱️ 31.08.2023) - [PyPi](https://pypi.org/project/mkrefs) (📥 150 / month): ``` pip install mkrefs ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkrefs ```
toc-sidebar - 🥉10 · ⭐ 5 · 💤 · MIT ·
An MkDocs plugin that allows users to add additional content to the ToC sidebar using the Material theme. - [GitHub](https://github.com/zachhannum/mkdocs-toc-sidebar-plugin) (👨‍💻 2 · 🔀 3 · 📦 40 · ⏱️ 11.01.2020) - [PyPi](https://pypi.org/project/mkdocs-toc-sidebar-plugin) (📥 5.3K / month): ``` pip install mkdocs-toc-sidebar-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - toc-sidebar ```
vim-md-tags - 🥉10 · ⭐ 5 · 💤 · MIT ·
An MkDocs plugin that creates a vim tag file of all markdown files. - [GitHub](https://github.com/zachhannum/mkdocs-vim-md-tags-plugin) (👨‍💻 4 · 🔀 1 · 📦 12 · ⏱️ 08.05.2020) - [PyPi](https://pypi.org/project/mkdocs-vim-md-tags-plugin) (📥 170 / month): ``` pip install mkdocs-vim-md-tags-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - vim-md-tags ```
mkdocs-pagetree-plugin - 🥉10 · ⭐ 2 · MIT ·
MkDocs plugin that allows you to display the page tree. Like `sitemap.xml`, but for humans. - [GitHub](https://github.com/tombreit/mkdocs-pagetree-plugin) (📦 11 · 📋 10 - 50% open · ⏱️ 14.05.2024) - [PyPi](https://pypi.org/project/mkdocs-pagetree-plugin) (📥 850 / month): ``` pip install mkdocs-pagetree-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - pagetree ```
include directory to navigation - 🥉9 · ⭐ 27 · 💤 · ❗Unlicensed ·
Simple MKDocs plugin than permit to fetch and replace directory in navigation. - [GitHub](https://github.com/mysiki/mkdocs_include_dir_to_nav) (🔀 2 · 📥 12 · 📋 4 - 50% open · ⏱️ 01.03.2022) - [PyPi](https://pypi.org/project/mkdocs-include-dir-to-nav) (📥 110K / month): ``` pip install mkdocs-include-dir-to-nav ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - include_dir_to_nav ```
mkdocs-categories-plugin - 🥉9 · ⭐ 13 · MIT ·
An MkDocs plugin allowing for categorization of wiki pages. - [GitHub](https://github.com/EddyLuten/mkdocs-categories-plugin) (📦 18 · ⏱️ 22.04.2024) - [PyPi](https://pypi.org/project/mkdocs-categories-plugin) (📥 980 / month): ``` pip install mkdocs-categories-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - categories ```
mkdocs-nav-enhancements - 🥉9 · ⭐ 3 · 💤 · MIT ·
WIP plugin for working with titles of pages in MkDocs. - [GitHub](https://github.com/Rylon/mkdocs-nav-enhancements) (📦 35 · ⏱️ 24.07.2019) - [PyPi](https://pypi.org/project/mkdocs-nav-enhancements) (📥 4.7K / month): ``` pip install mkdocs-nav-enhancements ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs-nav-enhancements ```
mkdocs-breadcrumbs-plugin - 🥉8 · 🐣 · MIT ·
Location-based breadcrumbs navigation. - [GitHub](https://github.com/mihaigalos/mkdocs-breadcrumbs-plugin) (👨‍💻 4 · 🔀 1 · 📦 2 · ⏱️ 06.09.2024) - [PyPi](https://pypi.org/project/mkdocs-breadcrumbs-plugin) (📥 960 / month): ``` pip install mkdocs-breadcrumbs-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs-breadcrumbs-plugin ```
mkdocs-live-edit-plugin - 🥉7 · ⭐ 15 · MIT ·
An MkDocs plugin that allows editing pages directly from the browser. - [GitHub](https://github.com/EddyLuten/mkdocs-live-edit-plugin) (👨‍💻 2 · 🔀 2 · 📦 9 · 📋 6 - 66% open · ⏱️ 07.03.2024) - [PyPi](https://pypi.org/project/mkdocs-live-edit-plugin) (📥 480 / month): ``` pip install mkdocs-live-edit-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - live-edit ```
SWAN Gallery - 🥉7 · ⭐ 1 · 💤 · ❗️AGPL-3.0 ·
MkDocs plugin to generate a SWAN Gallery. - [GitHub](https://github.com/swan-cern/mkdocs-swangallery) (👨‍💻 2 · 📦 3 · ⏱️ 20.07.2023) - [PyPi](https://pypi.org/project/mkdocs-swangallery) (📥 380 / month): ``` pip install mkdocs-swangallery ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - swangallery ```
select-files - 🥉7 · 💤 · Apache-2 ·
Filter pages for assignments. - [GitHub](https://github.com/supcik/mkdocs-select-files) (📦 9 · ⏱️ 05.09.2019) - [PyPi](https://pypi.org/project/mkdocs-select-files) (📥 200 / month): ``` pip install mkdocs-select-files ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - select-files ```
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](https://github.com/magicaljellybeans/mkdocs_schema_reader) (👨‍💻 3 · 🔀 3 · 📋 3 - 66% open · ⏱️ 23.06.2021) - [PyPi](https://pypi.org/project/mkdocs-schema-reader) (📥 1.1K / month): ``` pip install mkdocs-schema-reader ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - schema_reader ```
mkdocs-title-casing-plugin - 🥉5 · ⭐ 2 · 💤 · ❗️GPL-3.0 ·
A lightweight mkdocs plugin to add title casing to all mkdocs pages and sections. - [GitHub](https://github.com/mattchristopher314/mkdocs-title-casing-plugin) (📦 3 · ⏱️ 02.09.2023) - [PyPi](https://pypi.org/project/mkdocs-title-casing-plugin) (📥 860 / month): ``` pip install mkdocs-title-casing-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - title-casing ```
awesome-list - 🥉4 · ⭐ 5 · 💤 · MIT ·
MkDocs Plugin to inject social media cards for each entry in an awesome-list. - [GitHub](https://github.com/carlosperate/mkdocs-awesome-list-plugin) (⏱️ 26.07.2019) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - awesome-list ```
pagenav-generator - 🥉2 · ⭐ 4 · 💤 · MIT ·
Little something to automatically generate a Navigation within a page itself. Depends on Awesome-pages. - [GitHub](https://github.com/Andre601/mkdocs-pagenav-generator) (👨‍💻 2 · 🔀 1 · ⏱️ 17.04.2022) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - pagenav-generator ```
mkdocs-pug - 🥉2 · 💤 · ❗Unlicensed
Use pug templates with your mkdocs template. - [GitHub](https://github.com/vzhong/mkdocs_pug) (⏱️ 20.10.2021) - [PyPi](https://pypi.org/project/mkdocs-pug) (📥 70 / month): ``` pip install mkdocs-pug ```


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

Back to top

mktestdocs - 🥇20 · ⭐ 110 · Apache-2
Run pytest against markdown files/docstrings. - [GitHub](https://github.com/koaning/mktestdocs) (👨‍💻 5 · 🔀 8 · 📦 64 · 📋 6 - 33% open · ⏱️ 24.10.2024) - [PyPi](https://pypi.org/project/mktestdocs) (📥 12K / month): ``` pip install mktestdocs ```
mkdocs-spellcheck - 🥈15 · ⭐ 16 · ISC ·
A spell checker plugin for MkDocs. - [GitHub](https://github.com/pawamoy/mkdocs-spellcheck) (👨‍💻 4 · 🔀 3 · 📦 57 · 📋 19 - 36% open · ⏱️ 22.10.2024) - [PyPi](https://pypi.org/project/mkdocs-spellcheck) (📥 21K / month): ``` pip install mkdocs-spellcheck ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - spellcheck ```
Link Checker - 🥈9 · ⭐ 10 · 💤 · MIT
Python asyncio + aiohttp Markdown *.md URL link checker: 10,000 files/second. - [GitHub](https://github.com/byrnereese/linkchecker-mkdocs) (👨‍💻 5 · 🔀 4 · ⏱️ 24.08.2021) - [PyPi](https://pypi.org/project/mkdocs-linkcheck) (📥 5.9K / month): ``` pip install mkdocs-linkcheck ```
mkdocs-code-validator - 🥈9 · ⭐ 2 · MIT ·
Checks Markdown code blocks in a MkDocs site against user-defined actions. - [GitHub](https://github.com/oprypin/mkdocs-code-validator) (📦 16 · ⏱️ 27.04.2024) - [PyPi](https://pypi.org/project/mkdocs-code-validator) (📥 590 / month): ``` pip install mkdocs-code-validator ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - code-validator ```
mkdocs-codecheck - 🥉7 · ⭐ 2 · 💤 · MIT
Traverses a directory tree looking for code samples, then attempts to validate each code sample found. - [GitHub](https://github.com/byrnereese/codechecker-mkdocs) (👨‍💻 6 · ⏱️ 16.12.2021) - [PyPi](https://pypi.org/project/mkdocs-codecheck) (📥 260 / month): ``` pip install mkdocs-codecheck ```
MkDocs-Test - 🥉4 · ⭐ 2 · 🐣 · MIT ·
A framework for testing MkDocs projects. - [GitHub](https://github.com/fralau/mkdocs-test) (⏱️ 03.11.2024) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - test ```


🔍 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](https://github.com/chrieke/mkdocs-exclude-search) (👨‍💻 6 · 🔀 2 · 📥 14 · 📦 420 · ⏱️ 04.12.2023) - [PyPi](https://pypi.org/project/mkdocs-exclude-search) (📥 30K / month): ``` pip install mkdocs-exclude-search ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - exclude-search ```
localsearch - 🥈16 · ⭐ 32 · 💤 · MIT ·
A MkDocs plugin to make the native search plugin work locally (file:// protocol). - [GitHub](https://github.com/wilhelmer/mkdocs-localsearch) (👨‍💻 6 · 🔀 7 · 📦 85 · ⏱️ 02.01.2023) - [PyPi](https://pypi.org/project/mkdocs-localsearch) (📥 5.6K / month): ``` pip install mkdocs-localsearch ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - localsearch ```
tags - 🥉9 · ⭐ 42 · 💤 · MIT ·
Processes tags in yaml metadata. - [GitHub](https://github.com/jldiaz/mkdocs-plugin-tags) (👨‍💻 3 · 🔀 19 · 📋 14 - 42% open · ⏱️ 02.09.2021) - [PyPi](https://pypi.org/project/mkdocs-plugin-tags) (📥 600 / month): ``` pip install mkdocs-plugin-tags ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - tags ```
extract listings - 🥉9 · MIT ·
Generate a page with all listings and/or a search page for listings. - [GitHub](https://github.com/six-two/mkdocs-extract-listings-plugin) (⏱️ 06.10.2024) - [PyPi](https://pypi.org/project/mkdocs-extract-listings-plugin) (📥 2.1K / month): ``` pip install mkdocs-extract-listings-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - extract_listings ```
mkdocs-task-collector - 🥉5 · ⭐ 1 · 🐣 · MIT ·
mkdocs plugin to generate a comprehensive and organized task list, making it easier to manage and track tasks, notes,.. - [GitHub](https://github.com/costantinoai/mkdocs-task-collector) (📦 2 · ⏱️ 11.08.2024) - [PyPi](https://pypi.org/project/mkdocs-task-collector) (📥 1.4K / month): ``` pip install mkdocs-task-collector ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - task-collector ```


🍱 Site conversion (PDF/ePUB/etc.)

Back to top

print-site - 🥇24 · ⭐ 150 · MIT ·
MkDocs Plugin that adds an additional page that combines all pages, allowing easy exports to PDF and standalone HTML. - [GitHub](https://github.com/timvink/mkdocs-print-site-plugin) (👨‍💻 11 · 🔀 23 · 📦 350 · 📋 100 - 16% open · ⏱️ 12.09.2024) - [PyPi](https://pypi.org/project/mkdocs-print-site-plugin) (📥 30K / month): ``` pip install mkdocs-print-site-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - print-site ```
mkdocs-with-pdf - 🥇22 · ⭐ 330 · 💤 · MIT ·
Generate a single PDF file from MkDocs repository. - [GitHub](https://github.com/orzih/mkdocs-with-pdf) (👨‍💻 6 · 🔀 74 · 📦 620 · 📋 110 - 57% open · ⏱️ 14.10.2021) - [PyPi](https://pypi.org/project/mkdocs-with-pdf) (📥 54K / month): ``` pip install mkdocs-with-pdf ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - with-pdf ```
pdf-export - 🥇22 · ⭐ 320 · 💤 · MIT ·
An MkDocs plugin to export content pages as PDF files. - [GitHub](https://github.com/zhaoterryy/mkdocs-pdf-export-plugin) (👨‍💻 11 · 🔀 42 · 📦 1.2K · 📋 89 - 48% open · ⏱️ 05.10.2021) - [PyPi](https://pypi.org/project/mkdocs-pdf-export-plugin) (📥 33K / month): ``` pip install mkdocs-pdf-export-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - pdf-export ```
mkdocs-exporter - 🥈18 · ⭐ 80 · MIT ·
The fastest and most configurable plugin for MkDocs, allowing seamless export of individual pages and/or entire.. - [GitHub](https://github.com/adrienbrignon/mkdocs-exporter) (👨‍💻 4 · 🔀 7 · 📦 10 · 📋 37 - 29% open · ⏱️ 29.10.2024) - [PyPi](https://pypi.org/project/mkdocs-exporter) (📥 5.5K / month): ``` pip install mkdocs-exporter ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - exporter ```
mkpdfs - 🥈17 · ⭐ 100 · 💤 · ❗️GPL-3.0 ·
Converts your mkdocs documentation in PDF, to be shared with users. - [GitHub](https://github.com/comwes/mkpdfs-mkdocs-plugin) (👨‍💻 8 · 🔀 30 · 📥 41 · 📦 61 · 📋 39 - 30% open · ⏱️ 11.08.2021) - [PyPi](https://pypi.org/project/mkpdfs-mkdocs) (📥 2.9K / month): ``` pip install mkpdfs-mkdocs ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkpdfs ```
mkdocs-pandoc - 🥉14 · ⭐ 110 · 💤 · Apache-2
[unmaintained] mkdocs - pandoc converter: use this fork https://github.com/twardoch/mkdocs-combine. - [GitHub](https://github.com/jgrassler/mkdocs-pandoc) (👨‍💻 4 · 🔀 22 · 📦 53 · 📋 23 - 56% open · ⏱️ 14.03.2016) - [PyPi](https://pypi.org/project/mkdocs-pandoc) (📥 410 / month): ``` pip install mkdocs-pandoc ```
pdf-with-js - 🥉13 · ⭐ 8 · 💤 · MIT ·
A MkDocs plugin that exports your documentation as PDF with rendered JavaScript content. - [GitHub](https://github.com/smaxtec/mkdocs-pdf-with-js-plugin) (👨‍💻 4 · 🔀 3 · 📦 13 · ⏱️ 23.07.2021) - [PyPi](https://pypi.org/project/mkdocs-pdf-with-js-plugin) (📥 1.2K / month): ``` pip install mkdocs-pdf-with-js-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - pdf-with-js ```
mk2pdf-export - 🥉7 · ⭐ 10 · 💤 · MIT ·
The plugin is based on https://github.com/zhaoterryy/mkdocs-pdf-export-plugin/ ,the main change is use pandoc to.. - [GitHub](https://github.com/HaoLiuHust/mkdocs-mk2pdf-plugin) (👨‍💻 4 · 🔀 5 · 📦 3 · ⏱️ 11.09.2020) - [PyPi](https://pypi.org/project/mkdocs-mk2pdf-plugin) (📥 90 / month): ``` pip install mkdocs-mk2pdf-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mk2pdf-export ```
mkdocs-zip-folders - 🥉6 · ⭐ 2 · 💤 · MIT ·
MkDocs plugin to zip configured folders and add them to the site. - [GitHub](https://github.com/JakubAndrysek/mkdocs-zip-folders) (⏱️ 09.07.2023) - [PyPi](https://pypi.org/project/mkdocs-zip-folders) (📥 490 / month): ``` pip install mkdocs-zip-folders ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - zip_folders ```
helm - 🥉3 · ⭐ 1 · 💤 · Apache-2 ·
An mkdocs plugin that turns docs website into helm repository. - [GitHub](https://github.com/M00nF1sh/mkdocs-helm) (🔀 1 · ⏱️ 21.11.2018) - [PyPi](https://pypi.org/project/mkdocs-helm) (📥 89 / month): ``` pip install mkdocs-helm ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - helm-repo ```
mkdocs-autozip - 🥉2 · ⭐ 2 · 💤 · ❗Unlicensed ·
A mkdocs plugin for auto zipping the document source. - [GitHub](https://github.com/martinohanlon/mkdocs_autozip) (⏱️ 05.10.2022) - [PyPi](https://pypi.org/project/mkdocs-autozip) (📥 300 / month): ``` pip install mkdocs-autozip ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - autozip ```


🔧 Site building, site management

Back to top

mike - 🥇25 · ⭐ 550 · 📉 · BSD-3 ·
Manage multiple versions of your MkDocs-powered documentation via Git. - [GitHub](https://github.com/jimporter/mike) (👨‍💻 9 · 🔀 46 · 📥 300 · 📦 3.5K · 📋 180 - 5% open · ⏱️ 13.08.2024) - [PyPi](https://pypi.org/project/mike) (📥 400K / month): ``` pip install mike ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mike ```
monorepo - 🥇22 · ⭐ 320 · Apache-2 ·
Build multiple documentation folders in a single Mkdocs. Designed for large codebases. - [GitHub](https://github.com/backstage/mkdocs-monorepo-plugin) (👨‍💻 30 · 🔀 72 · 📦 490 · 📋 67 - 55% open · ⏱️ 04.01.2024) - [PyPi](https://pypi.org/project/mkdocs-monorepo-plugin) (📥 340K / month): ``` pip install mkdocs-monorepo-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - monorepo ```
techdocs-core - 🥇22 · ⭐ 89 · Apache-2 ·
The core MkDocs plugin used by Backstages TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown.. - [GitHub](https://github.com/backstage/mkdocs-techdocs-core) (👨‍💻 42 · 🔀 64 · 📦 74 · 📋 64 - 7% open · ⏱️ 31.10.2024) - [PyPi](https://pypi.org/project/mkdocs-techdocs-core) (📥 290K / month): ``` pip install mkdocs-techdocs-core ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - techdocs-core ```
mkdocs-multirepo-plugin - 🥈21 · ⭐ 130 · 📉 · MIT ·
Build documentation in multiple repos into one site. - [GitHub](https://github.com/jdoiro3/mkdocs-multirepo-plugin) (👨‍💻 17 · 🔀 47 · 📦 150 · 📋 110 - 51% open · ⏱️ 13.08.2024) - [PyPi](https://pypi.org/project/mkdocs-multirepo-plugin) (📥 68K / month): ``` pip install mkdocs-multirepo-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - multirepo ```
simple - 🥈21 · ⭐ 41 · Apache-2 ·
Build documentation files inside your code into a MkDocs site. - [GitHub](https://github.com/athackst/mkdocs-simple-plugin) (👨‍💻 8 · 🔀 10 · 📦 55 · 📋 19 - 5% open · ⏱️ 24.10.2024) - [PyPi](https://pypi.org/project/mkdocs-simple-plugin) (📥 20K / month): ``` pip install mkdocs-simple-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - simple ```
mkdocs-versioning - 🥈17 · ⭐ 40 · 💤 · MIT ·
A tool that allows for versioning sites built with mkdocs. - [GitHub](https://github.com/zayd62/mkdocs-versioning) (👨‍💻 5 · 🔀 6 · 📦 92 · 📋 25 - 12% open · ⏱️ 01.08.2021) - [PyPi](https://pypi.org/project/mkdocs-versioning) (📥 3.2K / month): ``` pip install mkdocs-versioning ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs-versioning ```
markdown-docs - 🥈17 · ⭐ 22 · MIT ·
Action/docker image that transforms your markdown into a static website. No need for particular configuration: it just.. - [GitHub](https://github.com/ldeluigi/markdown-docs) (👨‍💻 4 · 🔀 6 · 📦 74 · ⏱️ 28.10.2024) - [Docker Hub](https://hub.docker.com/r/deloo/markdown-docs) (📥 20K · ⏱️ 01.11.2024): ``` docker pull deloo/markdown-docs ```
Publisher for MkDocs - debugger - 🥈16 · ⭐ 61 · MIT ·
Advanced console and file logger from build and serve process. - [GitHub](https://github.com/mkdocs-publisher/mkdocs-publisher) (👨‍💻 2 · 🔀 2 · 📥 54 · 📦 61 · 📋 21 - 28% open · ⏱️ 11.08.2024) - [PyPi](https://pypi.org/project/mkdocs-publisher) (📥 2.6K / month): ``` pip install mkdocs-publisher ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - pub-debugger ```
same-dir - 🥈14 · ⭐ 37 · MIT ·
MkDocs plugin to allow placing mkdocs.yml in the same directory as documentation. - [GitHub](https://github.com/oprypin/mkdocs-same-dir) (👨‍💻 2 · 🔀 2 · 📦 360 · 📋 7 - 14% open · ⏱️ 03.02.2024) - [PyPi](https://pypi.org/project/mkdocs-same-dir) (📥 25K / month): ``` pip install mkdocs-same-dir ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - same-dir ```
MkDocs Merge - 🥈14 · ⭐ 22 · MIT
Merge the source of multiple MkDocs sites into a single one. - [GitHub](https://github.com/ovasquez/mkdocs-merge) (👨‍💻 3 · 🔀 6 · 📦 6 · 📋 9 - 55% open · ⏱️ 31.07.2024) - [PyPi](https://pypi.org/project/mkdocs-merge) (📥 2K / month): ``` pip install mkdocs-merge ```
mkdocs-exclude-unused-files - 🥉12 · ⭐ 4 · MIT ·
Exclude orphaned (unused) static files from your mkdocs build. - [GitHub](https://github.com/JonasDoesThings/mkdocs-exclude-unused-files) (👨‍💻 3 · 🔀 2 · 📥 4 · 📦 17 · 📋 3 - 33% open · ⏱️ 09.06.2024) - [PyPi](https://pypi.org/project/mkdocs-exclude-unused-files) (📥 1.4K / month): ``` pip install mkdocs-exclude-unused-files ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - exclude-unused-files ```
multirepo - 🥉11 · ⭐ 40 · MIT
A bit like monorepo, but keeps MkDocs projects separate. - [GitHub](https://github.com/wilhelmer/mkdocs-multirepo) (👨‍💻 3 · 🔀 2 · 📦 2 · ⏱️ 04.01.2024) - [PyPi](https://pypi.org/project/mkdocs-multirepo) (📥 970 / month): ``` pip install mkdocs-multirepo ```
mkdocs-yamp - 🥉9 · ⭐ 2 · 💤 · Apache-2 ·
Yet Another Multirepo Plugin for MkDocs. - [GitHub](https://github.com/boozallen/mkdocs-yamp-plugin) (👨‍💻 2 · 🔀 3 · 📦 7 · ⏱️ 10.10.2022) - [PyPi](https://pypi.org/project/mkdocs-yamp) (📥 240 / month): ``` pip install mkdocs-yamp ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - yamp ```
no-sitemap - 🥉8 · ⭐ 1 · 💤 · MIT ·
Disable Mkdocs sitemap generation. - [GitHub](https://github.com/leonardehrenfried/mkdocs-no-sitemap-plugin) (📦 17 · ⏱️ 04.04.2023) - [PyPi](https://pypi.org/project/mkdocs-no-sitemap-plugin) (📥 11K / month): ``` pip install mkdocs-no-sitemap-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - no-sitemap ```
mkdocs-exclude-tagged-files - 🥉7 · ⭐ 3 · 💤 · MIT ·
A mkdocs plugin for excluding files based on frontmatter tags. - [GitHub](https://github.com/JonasDoesThings/mkdocs-exclude-tagged-files) (👨‍💻 2 · 🔀 2 · 📦 4 · ⏱️ 10.09.2023) - [PyPi](https://pypi.org/project/mkdocs-exclude-tagged-files) (📥 400 / month): ``` pip install mkdocs-exclude-tagged-files ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs_exclude_tagged_files ```
mkdocs-required-frontmatter-plugin - 🥉7 · MIT ·
This MkDocs plugin enforces required frontmatter for documentation pages. - [GitHub](https://github.com/unmc-vcr/mkdocs-required-frontmatter-plugin) (📦 2 · ⏱️ 22.03.2024) - [PyPi](https://pypi.org/project/mkdocs-required-frontmatter-plugin) (📥 76 / month): ``` pip install mkdocs-required-frontmatter-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - required-frontmatter ```
mkdocs-auto-refresh-build-pages - 🥉7 · 🐣 · MIT ·
MkDocs plugin that automatically refreshes the build pages when the documentation is updated. - [GitHub](https://github.com/JakubAndrysek/mkdocs-auto-refresh-build-pages) (📦 4 · ⏱️ 02.07.2024) - [PyPi](https://pypi.org/project/mkdocs-auto-refresh-build-pages) (📥 110 / month): ``` pip install mkdocs-auto-refresh-build-pages ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - auto-refresh-build-pages ```
progress - 🥉6 · ⭐ 5 · 💤 · Apache-2 ·
A plugin for MkDocs that lets you know exactly what is happening during the build. - [GitHub](https://github.com/rdilweb/mkdocs-plugin-progress) (👨‍💻 3 · 📦 35 · ⏱️ 20.06.2020) - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - progress ```
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](https://github.com/kevin-411/mkdocs-new-features-notifier) (👨‍💻 2 · 🔀 1 · ⏱️ 15.01.2020) - [PyPi](https://pypi.org/project/mkdocs-new-features-notifier) (📥 1K / month): ``` pip install mkdocs-new-features-notifier ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - mkdocs-new-features-notifier ```
multiple - 🥉3 · ⭐ 1 · 💤 · ❗️GPL-3.0 ·
Allows to merge mkdocs documentations dynamically. - [GitHub](https://github.com/experimaestro/mkdocs-multiple) (👨‍💻 2 · ⏱️ 22.11.2019) - [PyPi](https://pypi.org/project/mkdocs-multiple) (📥 1K / month): ``` pip install mkdocs-multiple ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - multiple ```
octadocs-adr - 🥉3 · ⭐ 1 · 💤 · ❗Unlicensed ·
A blueprint for Architecture Decision Record in Octadocs - the smart documentation environment. - [GitHub](https://github.com/octadocs/octadocs-adr) (📦 2 · ⏱️ 22.08.2021) - [PyPi](https://pypi.org/project/octadocs-adr) (📥 78 / month): ``` pip install octadocs-adr ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - octadocs_adr ```


📁 Snippets & includes (reusing contents)

Back to top

include-markdown - 🥇24 · ⭐ 110 · Apache-2 ·
Mkdocs Markdown includer plugin. - [GitHub](https://github.com/mondeja/mkdocs-include-markdown-plugin) (👨‍💻 16 · 🔀 19 · 📥 480 · 📦 2.4K · ⏱️ 22.10.2024) - [PyPi](https://pypi.org/project/mkdocs-include-markdown-plugin) (📥 300K / month): ``` pip install mkdocs-include-markdown-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - include-markdown ```
Markdown-Include - 🥈21 · ⭐ 100 · 💤 · ❗️GPL-3.0 ·
Provides syntax for Python-Markdown which allows for the inclusion of the contents of other Markdown documents. - [GitHub](https://github.com/cmacmackin/markdown-include) (👨‍💻 12 · 🔀 37 · 📦 6.6K · 📋 26 - 26% open · ⏱️ 07.02.2023) - [PyPi](https://pypi.org/project/markdown-include) (📥 140K / month): ``` pip install markdown-include ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - markdown_include.include ```
meta-descriptions - 🥈20 · ⭐ 17 · MIT ·
Generate meta descriptions from the first paragraphs in your MkDocs pages. - [GitHub](https://github.com/prcr/mkdocs-meta-descriptions-plugin) (👨‍💻 3 · 🔀 3 · 📦 1.1K · 📋 11 - 9% open · ⏱️ 30.10.2024) - [PyPi](https://pypi.org/project/mkdocs-meta-descriptions-plugin) (📥 8.5K / month): ``` pip install mkdocs-meta-descriptions-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - meta-descriptions ```
codeinclude - 🥈15 · ⭐ 14 · 💤 · MIT ·
A plugin to include code snippets into mkdocs pages. - [GitHub](https://github.com/rnorth/mkdocs-codeinclude-plugin) (👨‍💻 4 · 🔀 7 · 📦 140 · 📋 12 - 41% open · ⏱️ 01.03.2023) - [PyPi](https://pypi.org/project/mkdocs-codeinclude-plugin) (📥 5.9K / month): ``` pip install mkdocs-codeinclude-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - codeinclude ```
mkdocs-embed-external-markdown - 🥉14 · ⭐ 10 · MIT ·
MkDocs Embed External Markdown plugin that allow to inject section or all full markdown content from a given url. The.. - [GitHub](https://github.com/fire1ce/mkdocs-embed-external-markdown) (👨‍💻 7 · 🔀 8 · 📦 120 · 📋 12 - 8% open · ⏱️ 22.08.2024) - [PyPi](https://pypi.org/project/mkdocs-embed-external-markdown) (📥 9.5K / month): ``` pip install mkdocs-embed-external-markdown ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - external-markdown ```
Mdx Include - 🥉11 · ⭐ 55 · 💤 · ❗Unlicensed ·
Python Markdown extension to include local or remote files. - [GitHub](https://github.com/neurobin/mdx_include) (👨‍💻 3 · 🔀 3 · 📋 9 - 44% open · ⏱️ 26.07.2022) - [PyPi](https://pypi.org/project/mdx-include) (📥 67K / month): ``` pip install mdx-include ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - mdx_include ```
snippet - 🥉11 · ⭐ 12 · 💤 · MIT ·
An mkdocs plugin that injects snippets from a file in a git repository. - [GitHub](https://github.com/mprivat/mkdocs-snippet-plugin) (👨‍💻 3 · 🔀 3 · 📦 23 · 📋 7 - 42% open · ⏱️ 21.10.2021) - [PyPi](https://pypi.org/project/mkdocs-snippet-plugin) (📥 1.6K / month): ``` pip install mkdocs-snippet-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - snippet ```
markdown-version-annotations - 🥉11 · ⭐ 5 · MIT ·
MkDocs plugin to add custom admonitions for documenting version differences. - [GitHub](https://github.com/glennmatthews/markdown-version-annotations) (📥 20 · 📦 37 · ⏱️ 06.05.2024) - [PyPi](https://pypi.org/project/markdown-version-annotations) (📥 4.4K / month): ``` pip install markdown-version-annotations ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#markdown_extensions): ```yaml markdown_extensions: - markdown_version_annotations ```
git snippet - 🥉10 · ⭐ 6 · 💤 · MIT ·
Mkdocs plugin that allow to inject snippet or all markdown content from a given remote git repository. - [GitHub](https://github.com/SamazoOo/mkdocs-gitsnippet-plugin) (👨‍💻 4 · 🔀 3 · 📦 10 · ⏱️ 15.11.2020) - [PyPi](https://pypi.org/project/mkdocs-gitsnippet-plugin) (📥 1.2K / month): ``` pip install mkdocs-gitsnippet-plugin ``` - Add to [mkdocs.yml](https://www.mkdocs.org/user-guide/configuration/#plugins): ```yaml plugins: - gitsnippet ```

Related Resources

Contribution

Contributions are encouraged and always welcome! If you like to add or update projects, choose one of the following ways:

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