Plugins¶

Extend MkDocs functionality with plugins.

Built-in Plugins¶

Search Plugin¶

plugins:
  - search:
      lang: en
      separator: '[\s\-\.]+'

Tags Plugin¶

Categorize pages with tags:

plugins:
  - tags

Use in pages:

---
tags:
  - tutorial
  - python
---

Popular Third-Party Plugins¶

Git Revision Date¶

Show last updated dates:

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

plugins:
  - git-revision-date-localized:
      enable_creation_date: true

Minify Plugin¶

Compress HTML/CSS/JS:

pip install mkdocs-minify-plugin

plugins:
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true

Awesome Pages¶

Auto-organize navigation:

pip install mkdocs-awesome-pages-plugin

plugins:
  - awesome-pages

Macros Plugin¶

Use variables and macros:

pip install mkdocs-macros-plugin

plugins:
  - macros

PDF Export¶

Generate PDF documentation:

pip install mkdocs-with-pdf

plugins:
  - with-pdf

Installing Plugins¶

Install via pip:
```
pip install plugin-name
```
Add to requirements.txt:
```
plugin-name>=1.0.0
```
Enable in mkdocs.yml:
```
plugins:
  - plugin-name
```

Plugin Configuration¶

plugins:
  - search:
      lang: en
  - tags:
      tags_file: tags.md
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago

Creating Custom Plugins¶

See MkDocs Plugin Development guide.

Resources¶

Back to Customization