# mdformat configuration — https://mdformat.readthedocs.io/en/stable/users/configuration_file.html

# Read by the mdformat CLI (pre-commit hook, CI, Makefile, and tools/generate_readmes.py).

# NOTE: the `exclude` key is intentionally NOT set here — it requires Python 3.13+,

# but the pre-commit hook runs under python3.12. Exclusions live in the hook's

# `exclude:` regex in .pre-commit-config.yaml instead.

# `extensions` is an allow-list: only the plugins named here are enabled, so any

# installed plugin we rely on must be listed:

# frontmatter - preserves YAML front matter (e.g. SPDX headers in onet)

# dollarmath - preserves $...$ and $$...$$ LaTeX math (used in ~40 READMEs)

# footnote - preserves [^ref] footnotes

# simple_breaks - renders thematic breaks as `---` instead of a line of underscores

# gfm_alerts - preserves GitHub alerts (> [!NOTE], > [!WARNING], ...)

# Without these, mdformat treats the constructs as prose and escapes/breaks them.

wrap = "no"

number = true

extensions = ["gfm", "frontmatter", "dollarmath", "footnote", "simple_breaks", "gfm_alerts"]