Skip to main content

mkdocs-techdocs-frontmatter

A MkDocs plugin that emits YAML frontmatter from Markdown pages as visible, indexable metadata during TechDocs generation.

Companion to the backstage-plugin-techdocs-addon-frontmatter Backstage TechDocs addon. See the repository README for full usage, configuration, and integration with Backstage search.

Install

pip install mkdocs-techdocs-frontmatter

Enable

# mkdocs.yml
plugins:
  - techdocs-core
  - techdocs-frontmatter:
      title: Article metadata
      render: true
      include: [type, author, last_review_date]
      labels:
        type: Type
        author: Author
        last_review_date: Last reviewed

License

MIT

Metadata

Release files for mkdocs-techdocs-frontmatter 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-techdocs-frontmatter 0.1.3
File Size Uploaded
mkdocs_techdocs_frontmatter-0.1.3.tar.gz 4.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-techdocs-frontmatter 0.1.3
File Interpreter ABI Platform
mkdocs_techdocs_frontmatter-0.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 10.4 kB

Release files / mkdocs_techdocs_frontmatter-0.1.3.tar.gz

Download URL mkdocs_techdocs_frontmatter-0.1.3.tar.gz
Size 4.8 kB
Tags Source
SHA-256 checksum
How to use checksums
47bb4070447065e62be690a5f2609b373a448c0e92b1d53a2eed14646191185d
BLAKE2b-256 checksum
How to use checksums
9b57b3311a433b644b152c945aaef25d574105ec52edb004f10599c428dae310
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.14

Release files / mkdocs_techdocs_frontmatter-0.1.3-py3-none-any.whl

Download URL mkdocs_techdocs_frontmatter-0.1.3-py3-none-any.whl
Size 5.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6467ebf95edc97deeae33904b8fea9c2d9ae1447836082bdcc45397ef0b60332
BLAKE2b-256 checksum
How to use checksums
a0239bd7a31ea75a63b0ddda261eacedcb15082dc1dbd6492aa5c4c5a3808fad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

0.1.3 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page