https://github.com/georgeyk/mkdocs-gentags

A mkdocs plugin to generate tags from metadata
https://github.com/georgeyk/mkdocs-gentags

mkdocs mkdocs-plugin tagging tags

Last synced: about 2 months ago
JSON representation

A mkdocs plugin to generate tags from metadata

• Host: GitHub
• URL: https://github.com/georgeyk/mkdocs-gentags
• Owner: georgeyk
• License: mit
• Created: 2024-05-16T17:21:54.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-05-18T23:35:51.000Z (12 months ago)
• Last Synced: 2025-03-02T19:37:35.720Z (about 2 months ago)
• Topics: mkdocs, mkdocs-plugin, tagging, tags
• Language: Python
• Homepage: https://georgeyk.github.io/mkdocs-gentags/
• Size: 857 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mkdocs-gentags

![](https://github.com/georgeyk/mkdocs-gentags/actions/workflows/tests.yml/badge.svg?branch=main)

![](https://github.com/georgeyk/mkdocs-gentags/actions/workflows/lint.yml/badge.svg?branch=main)

[![pypi](https://img.shields.io/pypi/v/mkdocs-gentags.svg)](https://pypi.python.org/pypi/mkdocs-gentags)

[![versions](https://img.shields.io/pypi/pyversions/mkdocs-gentags.svg)](https://github.com/georgeyk/mkdocs-gentags)

[![license](https://img.shields.io/github/license/georgeyk/mkdocs-gentags.svg)](https://github.com/georgeyk/mkdocs-gentags/blob/main/LICENSE)

---

A [mkdocs][1] plugin to generate tags from metadata (aka frontmatter).

Generates virtual files for tags, and inject context in the page objects to

facilitate rendering in custom templates. The virtual files behave as normal

files, they can be linked, indexed and so on.

In particular, this plugin is useful for those who want to customize their tags page.

For more information, installation steps and examples, see the [documentation][2].

## Related

Similar plugins:

- https://github.com/jldiaz/mkdocs-plugin-tags

- https://github.com/timmeinerzhagen/mkdocs-meta-manager

[1]: https://www.mkdocs.org

[2]: https://georgeyk.github.io/mkdocs-gentags/