An mdformat plugin for...
Project description
mdformat-plugin
An mdformat plugin for...
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
.
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_pelican-0.0.1.tar.gz
(5.2 kB
view hashes)
Built Distribution
Close
Hashes for mdformat_pelican-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1888260023c770a13b3b8dfdbc48ebd05a036730f79e1df7c6d4c6f13adeb8ef |
|
MD5 | 480f220d15daf38f264717c2727ad7d3 |
|
BLAKE2b-256 | 0c050329fee1d5f462b75edec2c86912846f21b6234dc96b15dfbc77099ffb25 |