mkdocs-auto-tag-plugin

What it is and what it does

mkdocs-auto-tag-plugin is a MkDocs plugin that automatically tags documentation pages based on their file paths and names. It uses glob patterns to match files and assign one or more tags to matching pages, with optional support for regex patterns and dynamic tag generation via capture groups. The plugin integrates directly into the MkDocs build pipeline and requires only mkdocs as a runtime dependency.

The package is designed for documentation sites that want to organize pages by topic or category without manually adding metadata to each file. It works by inspecting file paths and applying rules defined in the mkdocs.yml configuration. However, the project has been abandoned since its latest release on 2023-08-01 with no recent maintenance, so it may not work with newer mkdocs releases or receive bug fixes.

Use it for:

• Automatically tag blog posts by directory (e.g., all files under docs/blog/ get a 'blog' tag).
• Assign API documentation tags based on file path patterns without editing each page.
• Generate dynamic tags from file names using regex capture groups (e.g., extract version from filename).
• Organize large documentation sites by topic using glob-based rules in a single configuration file.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Automatically assigns tags to MkDocs pages based on their file path, parent directories, or file name using glob patterns and optional regex capture groups.

No. While the plugin is permissively licensed and has low install friction, it is abandoned and has not been updated since 2023-08-01. For a documentation site that must remain compatible with current mkdocs versions, the lack of maintenance poses a real risk. Consider it only if you are locked to an older mkdocs version and need this specific functionality.

Install

mkdocs-auto-tag-plugin on PyPI

pip install mkdocs-auto-tag-plugin

uv add mkdocs-auto-tag-plugin

poetry add mkdocs-auto-tag-plugin

Installing mkdocs-auto-tag-plugin

Before you install

Low friction install as a pure Python wheel with only mkdocs as a runtime dependency. However, the project is abandoned—last commit was 2023-08-01 and no updates have been released since the initial release period. Bug fixes and compatibility updates are unlikely.

License in practice

MIT License permits commercial and private use, modification, and redistribution with minimal restrictions, making it safe to adopt from a licensing standpoint.

Quickstart

pip install mkdocs-auto-tag-plugin

# In mkdocs.yml, add the plugin:
plugins:
  - auto-tag:
      globs:
        - pattern: 'docs/blog/**'
          tags: ['blog']
        - pattern: 'docs/api/.*\.md'
          tags: ['api']

Requires mkdocs to be installed and a valid mkdocs.yml configuration file in your project.

Verify before relying

• Whether the plugin remains compatible with current mkdocs versions given the last commit was 2023-08-01.
• Whether regex capture group functionality for dynamic tag generation works as documented.
• Performance impact when applied to large documentation sites with many files.

Package facts

Evidence: mkdocs_auto_tag_plugin-0.1.3-py3-none-any.whl

Tags

More Documentation packages