mdformat-simple-breaks
An mdformat plugin to render thematic breaks using three dashes
---
instead of 70 underscores
________________________________________________________________________________
Install
Install with:
pip install mdformat-simple-breaks
Usage as a pre-commit hook
Add the following to your .pre-commit-config.yaml:
- repo: https://github.com/executablebooks/mdformat
rev: 1.0.0 # Use the ref you want to point at
hooks:
- id: mdformat
additional_dependencies:
- mdformat-simple-breaks
Plugin rationale
The CommonMark specification states that thematic breaks, which are to be
rendered as horizontal rules <hr>, should be coded as:
A line consisting of optionally up to three spaces of indentation, followed by a sequence of three or more matching
-,_, or*characters, each followed optionally by any number of spaces or tabs
As a result, most of the Markdown guides and cheat sheets show a line made of three dash symbols as an example of a thematic break, and therefore this likely to be the format which Markdown writers are most used to type.
On the other hand, plain mdformat renders these thematic breaks as a line of 70 consecutive underscore characters. This is an explicit style decision that is not going to be reverted and for which no configuration will be added.
As a result, this plugin has been created to offer the option to render the thematic breaks using the common three dash style when preferred.
Metadata
Release files for mdformat_simple_breaks 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mdformat_simple_breaks-0.1.0.tar.gz | 6.7 kB | Without provenance | Details for mdformat_simple_breaks-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mdformat_simple_breaks-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for mdformat_simple_breaks-0.1.0-py3-none-any.whl |
Total release size: 10.9 kB
Release files / mdformat_simple_breaks-0.1.0.tar.gz
| Download URL | mdformat_simple_breaks-0.1.0.tar.gz |
|---|---|
| Size | 6.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0f1d57edba17d6ca7175031a3f2edb2e69ea5800c7c406c905e81e75a325470d
|
|
BLAKE2b-256 checksum How to use checksums |
97cf21faa8db8ac7548fc58424a82a48b4e6c53dcd45d4cf86494586e8eb4329
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.32.5
|
Release files / mdformat_simple_breaks-0.1.0-py3-none-any.whl
| Download URL | mdformat_simple_breaks-0.1.0-py3-none-any.whl |
|---|---|
| Size | 4.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c81c3d2ee65f0a0d9a968fb02347d1d34a14a6b0f3655c01e2a05bba10e8211f
|
|
BLAKE2b-256 checksum How to use checksums |
c161ae77d87133bd32c86631dcfb595a24432cec45d868c99b7e9b6b50597bf0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.32.5
|
Security for mdformat_simple_breaks 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.