mdformat-obsidian

Obsidian Flavored Markdown的mdformat插件。此插件直接支持Callouts和其他一些功能。更多文档将陆续提供，但在此期间，请参阅测试目录以了解支持的格式。

[!NOTE] GitHub Alerts的格式与Obsidian略有不同，因此它们不完全兼容。Obsidian支持折叠、自定义标题，并且不区分大小写。为了提高互操作性，此包选择将[!...]内的文本大写。

mdformat 使用方法

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

提示：此包指定了“额外” ('recommended')，用于与GFM配合良好的插件

• mdformat-beautysh
• mdformat-black
• mdformat-config
• mdformat-frontmatter
• mdformat-simple-breaks
• mdformat-tables
• mdformat-web
• mdformat-wikilink

提交前

repos:
  - repo: https://github.com/executablebooks/mdformat
    rev: 0.7.16
    hooks:
      - id: mdformat
        additional_dependencies:
          - mdformat-obsidian
          # Or
          # - "mdformat-obsidian[recommended]"

pipx

pipx install mdformat
pipx inject mdformat mdformat-obsidian
# Or
# pipx inject mdformat "mdformat-obsidian[recommended]"

HTML 渲染

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

from markdown_it import MarkdownIt

from mdformat_obsidian.mdit_plugins import obsidian_plugin

md = MarkdownIt()
md.use(obsidian_plugin)

text = "> [!tip] Callouts can have custom titles\n> Like this one."
md.render(text)
# <blockquote>

# </blockquote>

[!警告] 此软件包未正确处理将外部 blockquote 的 div 替换为 div 以提高可访问性。这应该可以通过 markdown-it 实现，但我还没有找到方法。

贡献

请参阅 CONTRIBUTING.md