mdformat-plugin

An mdformat plugin for the pelican static site generator. Pelican is a static site generator and uses markdown with a couple of additions, namely skipping the K:V pairs at the start and the ability to reference:

• tag
• author
• category
• index
• filename
• static
• attach

Note that the {name} forms are supported, and the |name| forms are converted to the newer form, as the pipe form has been deprecated.

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 py37-cov

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

To run the code formatting and style checks:

tox -e py37-pre-commit

or directly

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

To run the pre-commit hook test:

tox -e py37-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.