tags

Collects page tags from front matter, renders a hierarchical tag index into a marker, optionally hides shadow tags in production, and exports a tags.json.

Usage

Add tags to a page's front matter:

---
tags:
  - Networking
  - Networking/VLANs
tags_title: A friendlier name on the tags page
---

Then place the marker on your tags page (e.g. docs/tags.md):

# Tags

Nested tags separated by / nest under their parent, producing a hierarchical index.

Custom display name

Use the front-matter tags_title override to control how a page appears in the tag list (and in tags.json). Without it, the page's title (or first H1, or filename) is used.

Options

Option	Type	Default	Description
`export`	bool	`true`	Write a `tags.json` export.
`export_file`	string	`"tags.json"`	Export filename.
`shadow`	bool	`false`	Enable shadow-tag hiding.
`shadow_on_serve`	bool	`true`	Keep shadow tags visible during `serve`.
`shadow_tags_prefix`	string	`"_"`	Prefix that marks a tag as shadow.
`shadow_tags`	array	—	Explicit shadow-tag names.

{
  "name": "tags",
  "options": {
    "export": true,
    "shadow": true,
    "shadow_tags": [ "Draft", "Internal" ]
  }
}

Output

site/tags.json — a map of tag → [{ title, url }].

Attribution

Behavior is modeled on the Material for MkDocs tags plugin (MIT). See Attributions.