mdformat-frontmatter

An mdformat plugin for ensuring that yaml front-matter is respected. Many tools (such as jekyll) use yaml front matter for automation purposes. mdformat-frontmatter only supports yaml. For example:

---
test: yaml
---
# This looks okay
For some markdown code.

Frontmatter can only be at the first line or two of the code.

# This is not
---
test: yaml
---

Note: that at this stage this plugin is not that sophisticated. The principle objective is to allow properly formed yaml header blocks to pass through. Incorrectly formed blocks may result in strange behaviour.

Requirements

Python 3.10 or higher.

Development

This package was built from the template provided by executable books and customized (specifically to separate content PR's from the release cycle). This package uses hatch as the build engine, and tox for test automation.

To install development dependencies:

pip install -e ".[dev,test]"

To run the tests:

tox

and with test coverage:

tox -e py312-cov

The easiest way to write tests, is to edit tests/fixtures.md

To run the code formatting and style checks:

tox -e py312-pre-commit

or directly

pip install pre-commit
pre-commit run --all

To run the pre-commit hook test:

tox -e py312-hook

Release Process

Releases are fully automated using python-semantic-release and conventional commits:

1. Merge PRs with conventional commit titles (e.g., fix:, feat:, chore:)
2. The CI workflow automatically analyzes commits, determines version bump, updates CHANGELOG, creates a tag, and publishes to PyPI
3. Artifacts are signed with Sigstore for supply chain security

The release workflow uses PyPI Trusted Publishing (OIDC) and generates attestations for all published packages.