mdformat-footnote

What it is and what it does

mdformat-footnote is a plugin for mdformat that extends its Markdown formatting capabilities to handle footnotes. It integrates with mdformat's plugin system to parse, validate, and standardize footnote syntax in Markdown documents. The plugin depends on mdformat as its core formatter and mdit-py-plugins for the underlying parsing logic.

When installed, it allows mdformat to recognize and properly format footnote references and definitions according to a consistent style. This is useful for projects that use footnotes extensively and want to maintain uniform formatting across their documentation or content. The plugin is actively maintained and carries no known security vulnerabilities.

Use it for:

• Standardize footnote formatting across a documentation project using mdformat as part of a CI/CD pipeline.
• Validate footnote syntax in Markdown files to catch malformed references before publishing.
• Integrate footnote support into an existing mdformat-based linting or formatting workflow.
• Ensure consistent footnote style across multiple contributors in a collaborative documentation effort.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Adds footnote parsing and formatting support to mdformat, enabling validation and standardization of footnote syntax in Markdown documents.

Yes, if you use mdformat and need footnote support. The plugin has low install friction, active maintenance, permissive licensing, and no known vulnerabilities. Install it if your workflow requires footnote formatting; skip it if you don't use footnotes or prefer a different Markdown formatter.

Install

mdformat-footnote on PyPI

pip install mdformat-footnote

uv add mdformat-footnote

poetry add mdformat-footnote

Installing mdformat-footnote

Before you install

Low friction installation with only two runtime dependencies (mdformat and mdit-py-plugins). Repository is actively maintained with a recent commit on 2026-08-01 and no known vulnerabilities.

License in practice

Licensed under MIT (permissive), so you can use, modify, and distribute this package freely with minimal restrictions.

Quickstart

pip install mdformat-footnote

# Then use mdformat with footnote support:
mdformat --plugins mdformat_footnote document.md

Requires Python 3.10 or later.

Verify before relying

• Whether footnote formatting behavior matches common Markdown footnote conventions (e.g., Pandoc or GitHub flavored Markdown).
• Performance characteristics when processing large documents with many footnotes.

Package facts

Evidence: mdformat_footnote-0.1.3-py3-none-any.whl

Keywords: mdformat, markdown, markdown-it

Tags

More Python Modules packages