Skip to main content

An mdformat plugin for...

Project description

mdformat-pyproject

Build Status codecov.io PyPI version

An mdformat plugin to read configuration from pyproject.toml.

Install

Install with:

pip install mdformat-pyproject

Usage

After installing this plugin, the mdformat configuration can be added in a new [tool.mdformat] section inside the pyproject.toml file.

[tool.mdformat]
wrap = "keep"       # possible values: {"keep", "no", INTEGER}
number = false      # possible values: {false, true}
end_of_line = "lf"  # possible values: {"lf", "crlf", "keep"}

Usage as a pre-commit hook

Add the following to your .pre-commit-config.yaml:

- repo: https://github.com/executablebooks/mdformat
  rev: 0.7.13  # Use the ref you want to point at
  hooks:
    - id: mdformat
      additional_dependencies:
        - mdformat-pyproject

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_pyproject-0.0.2.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

mdformat_pyproject-0.0.2-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file mdformat_pyproject-0.0.2.tar.gz.

File metadata

  • Download URL: mdformat_pyproject-0.0.2.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for mdformat_pyproject-0.0.2.tar.gz
Algorithm Hash digest
SHA256 1638c4be0d239f49eea72089aafd06dc4ec603068ccc4868f91f0958b15b82c8
MD5 fa5f2981afe0d639bb4150183ab26346
BLAKE2b-256 5fb06c7342afcb5518891f3c908f9e9f73fc399b727fe5b8133b31c8d468eae6

See more details on using hashes here.

File details

Details for the file mdformat_pyproject-0.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for mdformat_pyproject-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e0791a335e53264d5589be353c519e230ac555b64fa076005bc64ca037717710
MD5 d46a6c8f7fe898396c723813024fabd5
BLAKE2b-256 bbd70598e8de54d439ee7deda6bcba7816b36aaf28c26542ff9a0510cc29c079

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