Skip to main content

Python-Markdown extension that renders TechDocs page frontmatter as searchable metadata.

Project description

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

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_techdocs_frontmatter-0.1.3.tar.gz (4.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_techdocs_frontmatter-0.1.3-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_techdocs_frontmatter-0.1.3.tar.gz.

File metadata

File hashes

Hashes for mkdocs_techdocs_frontmatter-0.1.3.tar.gz
Algorithm Hash digest
SHA256 47bb4070447065e62be690a5f2609b373a448c0e92b1d53a2eed14646191185d
MD5 0b38aa3d0ed3d2dedee6c4d0ed7eb9a0
BLAKE2b-256 9b57b3311a433b644b152c945aaef25d574105ec52edb004f10599c428dae310

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_techdocs_frontmatter-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6467ebf95edc97deeae33904b8fea9c2d9ae1447836082bdcc45397ef0b60332
MD5 675c791482d4ad090b83971d35d30b9c
BLAKE2b-256 a0239bd7a31ea75a63b0ddda261eacedcb15082dc1dbd6492aa5c4c5a3808fad

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