Skip to main content

An mdformat plugin for parsing/validating footnotes

Project description


Build Status PyPI version

Footnote format addition for mdformat.


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:


and with test coverage:

tox -e py39-cov

The easiest way to write tests, is to edit tests/

To run the code formatting and style checks:

tox -e py39-pre-commit

or directly

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

To run the pre-commit hook test:

tox -e py39-hook

Publish to PyPi

Either use flit directly:

pip install flit
flit publish

or trigger the GitHub Action job, by creating a release with a tag equal to the version, e.g. v0.0.1.

Note, this requires generating an API key on PyPi and adding it to the repository Settings/Secrets, under the name PYPI_KEY.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mdformat_footnote-0.1.1.tar.gz (5.2 kB view hashes)

Uploaded Source

Built Distribution

mdformat_footnote-0.1.1-py3-none-any.whl (4.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page