mdformat-gfm-alerts

这是一个mdformat插件，用于GitHub "Alerts"。 "Alerts"是admonitions的一种变体，由社区讨论提出，目前是GFM (GitHub-Flavored Markdown)语法的独立扩展。

mdformat用法

在任何使用mdformat的地方添加此包，插件将被自动识别。无需额外配置。有关mdformat插件的更多信息，请参阅此处

Pre-Commit

repos:
  - repo: https://github.com/executablebooks/mdformat
    rev: 0.7.16
    hooks:
      - id: mdformat
        additional_dependencies:
          - mdformat-gfm-alerts

pipx

pipx install mdformat
pipx inject mdformat mdformat-gfm-alerts

HTML渲染

要生成HTML输出，可以从mdit_plugins导入gfm_alerts_plugin。有关MarkdownIt的更多指导，请参阅文档：https://markdown-it-py.readthedocs.io/en/latest/using.html#the-parser

from markdown_it import MarkdownIt

from mdformat_gfm_alerts.mdit_plugins import gfm_alerts_plugin

md = MarkdownIt()
md.use(gfm_alerts_plugin)

text = "> [!NOTE]\n> Useful information that users should know, even when skimming content. "
md.render(text)
# <blockquote>
# <div class="markdown-alert markdown-alert-note">
# <p class="markdown-alert-title">Note</p>
# <p>Useful information that users should know, even when skimming content.</p>
# </div>
# </blockquote>

[!WARNING] 此包无法正确处理将blockquote外部的div替换为div以提高可访问性。这应该可以使用markdown-it完成，但我还没有找到方法。

贡献

请参阅CONTRIBUTING.md