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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file mkdocs-auto-tag-plugin-0.1.3.tar.gz.

File metadata

  • Download URL: mkdocs-auto-tag-plugin-0.1.3.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for mkdocs-auto-tag-plugin-0.1.3.tar.gz
Algorithm Hash digest
SHA256 be000bcc90c1b6f44196f531f4edecaff6fdff6ee5b5f5705f72df2d472c56b9
MD5 6e555dc008d086d3b89ea6977f4fbf55
BLAKE2b-256 38f175ebe665bf0705ea445f9e3e61b28d4bb5ca4d43033640832c084942d801

See more details on using hashes here.

File details

Details for the file mkdocs_auto_tag_plugin-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_auto_tag_plugin-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 51f35db1ba829eec77d6603085d1421c6864fb3fd6e7000b4769495e6af1c921
MD5 0b2e1edd806f22f720063bb7e9db1af4
BLAKE2b-256 597209eb907df1792e1268b6759f21ec918456a2c940ce3f6ed732a325e69116

See more details on using hashes here.

Supported by

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