Metadata-Version: 2.4
Name: mkdocs-techdocs-frontmatter
Version: 0.1.3
Summary: Python-Markdown extension that renders TechDocs page frontmatter as searchable metadata.
Author: Gijs Reijn
License-Expression: MIT
Project-URL: Homepage, https://github.com/Gijsreyn/backstage-plugin-techdocs-addon-frontmatter
Project-URL: Repository, https://github.com/Gijsreyn/backstage-plugin-techdocs-addon-frontmatter
Project-URL: Issues, https://github.com/Gijsreyn/backstage-plugin-techdocs-addon-frontmatter/issues
Keywords: mkdocs,mkdocs-plugin,techdocs,backstage,frontmatter
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Markdown>=3.4
Requires-Dist: mkdocs>=1.6
Requires-Dist: PyYAML>=6.0
Dynamic: license-file

# mkdocs-techdocs-frontmatter

A [MkDocs](https://www.mkdocs.org/) plugin that emits YAML frontmatter from
Markdown pages as visible, indexable metadata during TechDocs generation.

Companion to the
[`backstage-plugin-techdocs-addon-frontmatter`](https://github.com/Gijsreyn/backstage-plugin-techdocs-addon-frontmatter)
Backstage TechDocs addon. See the repository README for full usage,
configuration, and integration with Backstage search.

## Install

```sh
pip install mkdocs-techdocs-frontmatter
```

## Enable

```yaml
# 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
