Skip to main content

An mdformat plugin for markdown-it-deflist.

Project description

mdformat-deflist

Build Status codecov.io PyPI version

An mdformat plugin for markdown-it-deflist.

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_deflist-0.1.2.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

mdformat_deflist-0.1.2-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file mdformat_deflist-0.1.2.tar.gz.

File metadata

  • Download URL: mdformat_deflist-0.1.2.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for mdformat_deflist-0.1.2.tar.gz
Algorithm Hash digest
SHA256 7b4bd183507c37dcff7bffaf8e442d7b69e4d90fb94558fe95b3ece68ec94cf0
MD5 3bb0b9c738793ac5a59eb43e92d74e73
BLAKE2b-256 adb0c57cbc52295bec414f4fc5ea127f946f9a3717c19ba86293fc2d3e5d4734

See more details on using hashes here.

File details

Details for the file mdformat_deflist-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for mdformat_deflist-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 301c3bb1daf393cdf020135e8d596023b6da0c4b09d3deb06e53b48281d76828
MD5 034e29263a2526bb2782861fbdfdfb4a
BLAKE2b-256 8b4c39e7402db5504297bf30b5f08a4e87aa0b0981ae3870f63e51abc7fdfcba

See more details on using hashes here.

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