https://github.com/executablebooks/mdformat-footnote
Footnote format addition for mdformat
https://github.com/executablebooks/mdformat-footnote
markdown markdown-it mdformat
Last synced: 3 months ago
JSON representation
Footnote format addition for mdformat
- Host: GitHub
- URL: https://github.com/executablebooks/mdformat-footnote
- Owner: executablebooks
- License: mit
- Created: 2021-03-20T10:50:00.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-12-01T00:43:39.000Z (4 months ago)
- Last Synced: 2025-12-20T06:08:14.944Z (3 months ago)
- Topics: markdown, markdown-it, mdformat
- Language: Python
- Homepage:
- Size: 54.7 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mdformat-footnote
[![Build Status][ci-badge]][ci-link]
[![codecov.io][cov-badge]][cov-link]
[![PyPI version][pypi-badge]][pypi-link]
Footnote format addition for [mdformat](https://github.com/executablebooks/mdformat).
## Development
This package utilises [flit](https://flit.readthedocs.io) as the build engine, and [tox](https://tox.readthedocs.io) for test automation.
To install these development dependencies:
```bash
pip install tox
```
To run the tests:
```bash
tox
```
and with test coverage:
```bash
tox -e py310-cov
```
The easiest way to write tests, is to edit tests/fixtures.md
To run the code formatting and style checks:
```bash
tox -e py310-pre-commit
```
or directly
```bash
pip install pre-commit
pre-commit run --all
```
To run the pre-commit hook test:
```bash
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.
[ci-badge]: https://github.com/gaige/mdformat-footnote/workflows/CI/badge.svg?branch=master
[ci-link]: https://github.com/gaige/mdformat-footnote/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush
[cov-badge]: https://codecov.io/gh/gaige/mdformat-footnote/branch/master/graph/badge.svg
[cov-link]: https://codecov.io/gh/gaige/mdformat-footnote
[pypi-badge]: https://img.shields.io/pypi/v/mdformat-footnote.svg
[pypi-link]: https://pypi.org/project/mdformat-footnote