Skip to main content

An mdformat plugin for parsing / ignoring frontmatter.

Project description

mdformat-frontmatter

Build Status codecov.io PyPI version

An mdformat plugin for ensuring that yaml frontmatter is respected. As we are unable to tell the intent of a user if the yaml is incorrectly formatted it will trigger an exception.

This package was built from the template provided by executable books and customized (specifically to separate content PR's from the release cycle).

Development

This package dirver 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_frontmatter-0.1.1.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

mdformat_frontmatter-0.1.1-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file mdformat_frontmatter-0.1.1.tar.gz.

File metadata

  • Download URL: mdformat_frontmatter-0.1.1.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.25.1

File hashes

Hashes for mdformat_frontmatter-0.1.1.tar.gz
Algorithm Hash digest
SHA256 839692bae977ec0ab5d32bf8c1a30848b9ba12f8da6d5d18c91f9fb4c133fb8f
MD5 08d88ba0f492cf50dadb1c768049b3c3
BLAKE2b-256 99af58da859cd57b358e5d5515767c3c4f67b9edccf6c3939de41b1f71cc5aab

See more details on using hashes here.

File details

Details for the file mdformat_frontmatter-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mdformat_frontmatter-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 412dd9c33ac0077799803ce12b9c8f8c16019b232a50745fd5b862c35b8ba151
MD5 6dffb91a4fdd778fba782c4ca60e65ec
BLAKE2b-256 9b62807ab522c0c71db8233b845dbf12cdad7a4942ad360eabb013efb81313f0

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