🧭 Navigation & page building

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

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

PyPi (📥 200K / month):

pip install mkdocs-awesome-pages-plugin

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

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

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

PyPi (📥 7.6K / month):

pip install mkdocs-encryptcontent-plugin

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

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

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

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

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

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

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

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

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

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

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

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

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

Publisher for MkDocs - meta - 🥈14 · ⭐ 27 · ➕ · MIT ·
Navigation and page building based on files metadata.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

schema-reader - 🥉7 · ⭐ 3 · 💤 · MIT ·
A mkdocs plugin that scans specified directories and files for JSON Schema files, converts them to markdown and builds..

GitHub (👨‍💻 3 · 🔀 3 · 📋 3 - 66% open · ⏱️ 23.06.2021)
PyPi (📥 1.3K / month):
```
pip install mkdocs-schema-reader
```
Add to mkdocs.yml:
```
plugins:
  - schema_reader
```

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

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

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

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

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

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

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

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

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

GitHub (⏱️ 02.09.2023)
PyPi (📥 250 / month):
```
pip install mkdocs-title-casing-plugin
```
Add to mkdocs.yml:
```
plugins:
  - title-casing
```

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

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

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

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