mdformat_simple_breaks 0.0.1

An mdformat plugin for...

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: 0.7.13  # 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:

---

On the other hand, mdformat renders these thematics breaks by default 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 override that decision and go back to the three - thematic breaks.