Skip to content

MkDocs plugins

Zensical provides native implementations of the MkDocs plugins listed below, meaning they continue to work with your existing configuration and project structure. In most cases, no additional packages are required as our implementations are behavior-preserving rewrites.

We aim to match their behavior as closely as possible and document the remaining differences.

Configuration

Existing mkdocs.yml plugin configuration can remain unchanged. For example:

plugins:
  - tags
  - minify:
      minify_html: true

If your project already uses zensical.toml:

[project.plugins.tags]

[project.plugins.minify]
minify_html = true

The original documentation for each plugin (linked below) remains the reference for usage and configuration. We're working on shipping a growing list of supported plugins, as well as Zensical's own native public module API.

If you're lazy like us, use Zensical Studio to get completions and validation for all supported plugins directly in your editor inside zensical.toml and mkdocs.yml configuration files.

Supported plugins

Plugins are listed alphabetically. Most implementations require no additional installation. Each entry links to the original plugin documentation, which remains the reference for settings and usage, and to the Zensical release in which support was added.

The plugin I need isn't listed. What can I do?

Check our public backlog to see whether support is already planned. If it isn't, create a change request for the missing plugin in Zensical's issue tracker.

autorefs

Since 0.0.22

See plugin documentation for usage and configuration.

awesome-nav

Since 0.0.58

See plugin documentation for usage and configuration.

Differences:

  • Extglob expressions are not supported; regular glob patterns are supported.
  • MkDocs' not_in_nav setting is not supported.

glightbox

Since 0.0.35

See plugin documentation for usage and configuration.

literate-nav

Since 0.0.58

See plugin documentation for usage and configuration.

macros

Since 0.0.40

See plugin documentation for usage and configuration.

Differences:

  • Referenced Python and YAML files must be inside the project directory.

markdown-exec

Since 0.0.47

Install with:

pip install "markdown-exec[ansi]"

See plugin documentation for usage and configuration.

meta

Since 0.0.58

See plugin documentation for usage and configuration.

minify

Since 0.0.58

See plugin documentation for usage and configuration.

Differences:

  • Assets that cannot be parsed retain their original content instead of crashing the build.

mkdocstrings

Since 0.0.11

Install with:

pip install mkdocstrings-python

See plugin documentation for usage and configuration.

Differences:

  • Backlinks are not supported.
  • Sources outside the project directory are not watched during preview.

offline

Since 0.0.3

See plugin documentation for usage and configuration.

redirects

Since 0.0.58

See plugin documentation for usage and configuration.

Since 0.0.3

See plugin documentation for usage and configuration.

section-index

Since 0.0.3

No configuration options are required.

table-reader

Since 0.0.41

See plugin documentation for usage and configuration.

tags

Since 0.0.58

See plugin documentation for usage and configuration.

Acknowledgements

We thank all plugin authors and contributors for building and maintaining the MkDocs plugin ecosystem. Where Zensical provides native implementations, they are bottom-up rewrites that reproduce the plugins' configuration and behavior without using their original codebases.