mdformat-footnote

Footnote format addition for mdformat.

Development

This package utilises flit as the build engine, and tox for test automation.

To install these development dependencies:

pip install tox

To run the tests:

tox

and with test coverage:

tox -e py310-cov

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

To run the code formatting and style checks:

tox -e py310-pre-commit

or directly

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

To run the pre-commit hook test:

tox -e py310-hook

Publish to PyPi

Publishing is handled using a trusted action as part of the release process. Authentication is via OIDC and should be triggered by creating a release with a tag equal to the version, e.g. v0.0.1.

Maintainer note: this is configured in PyPI as a trusted repository.