An mdformat plugin for...
Project description
mdformat-admon
An mdformat plugin for admonitions.
Development
This package utilizes 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mdformat_admon-0.0.1.tar.gz
(5.4 kB
view hashes)
Built Distribution
Close
Hashes for mdformat_admon-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3dc0524a0a99568e294f2f8837f6c3cdf042f562533e0d0d865215895ddaa5e6 |
|
MD5 | e36c78969bff61df3ab6bf705bb482e0 |
|
BLAKE2b-256 | ef2ec98a3486777c757f45597527e60691ca917ce11acc3d481e704a8c57e2cf |