Skip to main content

Add tags to your MkDocs pages based on their path / file name

Project description

mkdocs-auto-tag-plugin

PyPI version License Python versions

This plugin is designed to add tags to files based on their path (parent direcctories or file name).

Documentation

This README is just a short intro to the package. For a quick start and detailed information please see the documentation. The documentation is also available in the docs folder of the source code and can be built localy with MkDocs.

Tests

The files in the docs/test/ directory implicitely work as tests. They should be tagged correctly.

Notable changes

0.1.3

  • Just fixed the DeprecationWarning for warning_filter

0.1.2

  • Just small documentation changes. But I needed to increase the version number to remove the !!! Warning: Pre alpha: This is currently just a PoC for myself line from the PyPI site

0.1.1

  • Added support for assigning lists of tag to globs.
  • Added regex support
    • Capture groups can be used to generate dynamic tags

0.1.0

  • Implemented working prototype that uses custom globs for the file path matching.

0.0.1

  • Reserved name on PyPI

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-auto-tag-plugin-0.1.3.tar.gz (5.8 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_auto_tag_plugin-0.1.3-py3-none-any.whl (6.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page