mdformat-footnote is a plugin for the opinionated Markdown formatter `mdformat`. It extends `mdformat` to properly parse, validate, and format Pandoc-style footnotes, ensuring consistent styling within Markdown documents. The current version is 0.1.3, and releases are tied to supporting new `mdformat` versions or addressing specific formatting issues.
pip install mdformat mdformat-footnoteVerified import paths — ran on the pinned version, not inferred.
To use `mdformat-footnote`, you need to install both `mdformat` and `mdformat-footnote`. Then, when using `mdformat` (either via the Python API or CLI), you must explicitly enable the 'footnote' extension.
Upgrade mdformat-footnote to 0.1.2 or later: `pip install --upgrade mdformat-footnote`. Ensure your Python environment is 3.10 or newer.
Always enable the 'footnote' extension when you intend to format documents containing footnotes, either via the CLI (`mdformat --extensions footnote your_file.md`) or Python API (`mdformat.text(..., extensions={'footnote'})`).Pin your `mdformat` and `mdformat-footnote` versions in your `requirements.txt` or `pyproject.toml` (e.g., `mdformat==1.0.0`, `mdformat-footnote==0.1.3`) to ensure consistent formatting across runs and environments.