SuperAPI AI 工具集

obsidian-markdown

写作与研究

查看项目

更新于 10-14 05:33

技能介绍

用途

obsidian-markdown 是一个用于创建和编辑 Obsidian Flavored Markdown 的技能,主要面向 .md 文件的编写场景。根据资料,Obsidian 在 CommonMark 和 GFM 基础上扩展了 wikilinks、嵌入、标注(callouts)、属性(properties)、注释等语法。该技能只覆盖 Obsidian 专有的扩展语法,标准 Markdown(标题、加粗、斜体、列表、引用、代码块、表格)被视为前提知识。

主要能力

资料描述的工作流包含以下步骤:

  1. 在文件顶部添加含属性的 frontmatter(title、tags、aliases 等),属性类型参见 PROPERTIES.md。
  2. 使用标准 Markdown 组织结构,并配合 Obsidian 专有语法编写内容。
  3. 使用 wikilinks([[Note]])链接相关笔记,用于库内连接;外部 URL 则使用标准 Markdown 链接。
  4. 使用 ![[embed]] 语法嵌入其他笔记、图片或 PDF 的内容,嵌入类型参见 EMBEDS.md。
  5. 使用 > [!type] 语法添加标注以突出信息,标注类型参见 CALLOUTS.md。
  6. 在 Obsidian 的阅读视图中验证笔记渲染是否正确。

在 wikilink 与 Markdown 链接之间选择时:库内笔记使用 [[wikilinks]](Obsidian 会自动跟踪重命名),外部 URL 仅使用 text。

技能涵盖的语法包括:

  • 内部链接(Wikilinks):链接到笔记、使用自定义显示文本、链接到标题、链接到块、同一笔记内的标题链接。块 ID 通过在任何段落后追加 ^block-id 定义;列表和引用则将块 ID 放在该块之后的单独一行。
  • 嵌入:在任何 wikilink 前加 ! 即可内联嵌入内容,可嵌入完整笔记、章节、图片(可指定宽度)、PDF 页面等。音频、视频、搜索嵌入和外部图片参见 EMBEDS.md。
  • 标注(Callouts):使用 > [!note]、> [!warning] Custom Title、> [!faq]- Collapsed by default 等写法;可折叠标注使用 -(折叠)和 +(展开)。常见类型包括 note、tip、warning、info、example、quote、bug、danger、success、failure、question、abstract、todo。完整列表(含别名、嵌套和自定义 CSS 标注)参见 CALLOUTS.md。
  • 属性(Frontmatter):可定义 title、date、tags、aliases、cssclasses 等。默认属性包括 tags(可搜索标签)、aliases(用于链接建议的替代笔记名)、cssclasses(用于样式的 CSS 类)。全部属性类型、标签语法规则和高级用法参见 PROPERTIES.md。
  • 标签:支持内联标签 #tag 和嵌套层级标签 #nested/tag。标签可包含字母、数字(不能作为首字符)、下划线、连字符和正斜杠,也可在 frontmatter 的 tags 属性中定义。
  • 注释:使用 %%隐藏内容%% 隐藏行内文本,或使用 %% 包裹整块内容使其在阅读视图中隐藏。
  • Obsidian 专有格式:==高亮文本==。
  • 数学(LaTeX):行内使用 $e^{i\pi} + 1 = 0$,块级使用 $$ \frac{a}{b} = c $$。
  • 图表(Mermaid):使用 ```mermaid 代码块绘制流程图等;要将 Mermaid 节点链接到 Obsidian 笔记,需添加 class NodeName internal-link;。
  • 脚注:支持引用式脚注 [^1] 和行内脚注 ^[This is inline.]。

资料还提供了一个完整的笔记示例,包含 frontmatter、wikilink、标注、任务列表、行内数学、图片嵌入和章节链接等综合用法。

使用方式

资料未提供该技能的具体安装命令、调用方式或运行环境配置,暂未提供。

适用场景

适用于处理 Obsidian 库中的 .md 文件,尤其是需要使用 Obsidian 专有扩展语法(wikilinks、嵌入、标注、属性、标签、注释、高亮、数学、Mermaid 图表、脚注)来创建和组织笔记的场景。

限制

该技能只覆盖 Obsidian 专有扩展,标准 Markdown 语法被视为前提知识,不在其覆盖范围内。资料未提供关于收费、价格、平台支持范围或实际使用效果的说明,暂未提供。