mdformat-simple-breaks

一个使用三个短横线而不是70个下划线来渲染主题断开的mdformat插件。

安装

使用以下方法安装

pip install mdformat-simple-breaks

作为pre-commit钩子使用

将以下内容添加到您的.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

插件理由

CommonMark规范指出，主题断开，应以水平线<hr>的形式呈现，应编码为

一个由可选的最多三个空格缩进组成的一行，后跟一个由三个或更多匹配的-、_或*字符组成的序列，每个字符后面可选地跟任意数量的空格或制表符

因此，大多数Markdown指南和速查表都显示由三个短横线符号组成的行作为主题断开的示例

---

另一方面，mdformat默认将这些主题断开渲染为70个连续的下划线字符的一行

________________________________________________________________________________

这是一个明确的风格决策，不会撤销，也不会添加任何配置。

因此，已创建此插件来覆盖该决策并恢复到三个-主题断开。