# mdformat-simple-breaks
[![Build Status][ci-badge]][ci-link]
[![codecov.io][cov-badge]][cov-link]
[![PyPI version][pypi-badge]][pypi-link]
An [mdformat][mdformat] plugin to render thematic breaks
using three dashes instead of 70 underscores.
## Install
Install with:
```bash
pip install mdformat-simple-breaks
```
## Usage as a [pre-commit](https://pre-commit.com) hook
Add the following to your `.pre-commit-config.yaml`:
```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-simple-breaks
```
## Plugin rationale
The [CommonMark specification][commonmark-spec] 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:
```
---
```
On the other hand, [mdformat][mdformat] renders these thematics breaks by default as a line of 70
consecutive underscore characters:
```
________________________________________________________________________________
```
This is an [explicit style decision][style-change] that is not going to be reverted and for which
no configuration will be added.
As a result, this plugin has been created to override that decision and go back to the three `-`
thematic breaks.
[ci-badge]: https://github.com/csala/mdformat-simple-breaks/workflows/CI/badge.svg?branch=master
[ci-link]: https://github.com/csala/mdformat/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush
[cov-badge]: https://codecov.io/gh/csala/mdformat-simple-breaks/branch/master/graph/badge.svg
[cov-link]: https://codecov.io/gh/csala/mdformat-simple-breaks
[pypi-badge]: https://img.shields.io/pypi/v/mdformat-simple-breaks.svg
[pypi-link]: https://pypi.org/project/mdformat-simple-breaks
[mdformat]: https://github.com/executablebooks/mdformat
[commonmark-spec]: https://spec.commonmark.org/0.30/#thematic-breaks
[style-change]: https://github.com/executablebooks/mdformat/issues/69
Raw data
{
"_id": null,
"home_page": null,
"name": "mdformat_simple_breaks",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "mdformat,markdown,markdown-it",
"author": null,
"author_email": "Carles Sala <csala@csail.mit.com>",
"download_url": "https://files.pythonhosted.org/packages/62/af/5b88367b69084c8bc60cfc4103eb62482655f8dbbb6dc81431aa27455b22/mdformat_simple_breaks-0.0.1.tar.gz",
"platform": null,
"description": "# mdformat-simple-breaks\n\n[![Build Status][ci-badge]][ci-link]\n[![codecov.io][cov-badge]][cov-link]\n[![PyPI version][pypi-badge]][pypi-link]\n\nAn [mdformat][mdformat] plugin to render thematic breaks\nusing three dashes instead of 70 underscores.\n\n\n## Install\n\nInstall with:\n\n```bash\npip install mdformat-simple-breaks\n```\n\n## Usage as a [pre-commit](https://pre-commit.com) hook\n\nAdd the following to your `.pre-commit-config.yaml`:\n\n```yaml\n- repo: https://github.com/executablebooks/mdformat\n rev: 0.7.13 # Use the ref you want to point at\n hooks:\n - id: mdformat\n additional_dependencies:\n - mdformat-simple-breaks\n```\n\n## Plugin rationale\n\nThe [CommonMark specification][commonmark-spec] states that thematic breaks, which are to be\nrendered as horizontal rules `<hr>`, should be coded as:\n\n> A line consisting of optionally up to three spaces of indentation, followed by a sequence of\n> three or more matching `-`, `_`, or `*` characters, each followed optionally by any number of\n> spaces or tabs\n\nAs a result, most of the Markdown guides and cheat sheets show a line made of three dash symbols\nas an example of a thematic break:\n\n```\n---\n```\n\nOn the other hand, [mdformat][mdformat] renders these thematics breaks by default as a line of 70\nconsecutive underscore characters:\n\n```\n________________________________________________________________________________\n```\n\nThis is an [explicit style decision][style-change] that is not going to be reverted and for which\nno configuration will be added.\n\nAs a result, this plugin has been created to override that decision and go back to the three `-`\nthematic breaks.\n\n\n[ci-badge]: https://github.com/csala/mdformat-simple-breaks/workflows/CI/badge.svg?branch=master\n[ci-link]: https://github.com/csala/mdformat/actions?query=workflow%3ACI+branch%3Amaster+event%3Apush\n[cov-badge]: https://codecov.io/gh/csala/mdformat-simple-breaks/branch/master/graph/badge.svg\n[cov-link]: https://codecov.io/gh/csala/mdformat-simple-breaks\n[pypi-badge]: https://img.shields.io/pypi/v/mdformat-simple-breaks.svg\n[pypi-link]: https://pypi.org/project/mdformat-simple-breaks\n[mdformat]: https://github.com/executablebooks/mdformat\n[commonmark-spec]: https://spec.commonmark.org/0.30/#thematic-breaks\n[style-change]: https://github.com/executablebooks/mdformat/issues/69\n",
"bugtrack_url": null,
"license": null,
"summary": "An mdformat plugin for...",
"version": "0.0.1",
"split_keywords": [
"mdformat",
"markdown",
"markdown-it"
],
"urls": [
{
"comment_text": null,
"digests": {
"md5": "172f9bb7298ebb0e05ece35760dc6f03",
"sha256": "3dde7209d509620fdd2bf11e780ae32d5f61a80ea145a598252e2703f8571407"
},
"downloads": -1,
"filename": "mdformat_simple_breaks-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "172f9bb7298ebb0e05ece35760dc6f03",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4012,
"upload_time": "2022-12-29T16:43:52",
"upload_time_iso_8601": "2022-12-29T16:43:52.162325Z",
"url": "https://files.pythonhosted.org/packages/20/1d/8e992c96d7ac86f85e1b4094d3887658376443b56679b834de8b23f4f849/mdformat_simple_breaks-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"md5": "aa526ad4f7ead6d9153946c9f647f69f",
"sha256": "36dbd4981e177526c08cfd9b36272dd2caf230d7a2c2834c852e57a1649f676a"
},
"downloads": -1,
"filename": "mdformat_simple_breaks-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "aa526ad4f7ead6d9153946c9f647f69f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 6501,
"upload_time": "2022-12-29T16:43:53",
"upload_time_iso_8601": "2022-12-29T16:43:53.585630Z",
"url": "https://files.pythonhosted.org/packages/62/af/5b88367b69084c8bc60cfc4103eb62482655f8dbbb6dc81431aa27455b22/mdformat_simple_breaks-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-29 16:43:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "mdformat_simple_breaks"
}
JSON