SuperAPI AI 工具集

obsidian-markdown

写作与研究

查看项目

更新于 11-06 16:20

技能介绍

用途

本技能用于创建和编辑有效的 Obsidian 风格 Markdown。Obsidian 在 CommonMark 和 GFM 基础上扩展了 wikilinks、嵌入、标注块、属性、注释等语法。该技能只覆盖 Obsidian 专有扩展,标准 Markdown(标题、粗体、斜体、列表、引用、代码块、表格)被视为已有知识。

主要能力

  • 内链(Wikilinks):支持链接到笔记、自定义显示文本、链接到标题、链接到块,以及同笔记内标题链接。块 ID 通过 ^block-id 定义;列表和引用需在块后另起一行放置块 ID。
  • 嵌入:在 wikilink 前加 ! 可内联嵌入内容,支持嵌入整篇笔记、章节、图片(可指定宽度,如 ![[image.png|300]])和 PDF 页面(如 ![[document.pdf#page=3]])。
  • 标注块(Callouts):使用 > [!type] 语法,支持自定义标题、可折叠(- 默认折叠、+ 展开)。常见类型包括 note、tip、warning、info、example、quote、bug、danger、success、failure、question、abstract、todo。
  • 属性(Frontmatter):文件顶部 --- 之间定义属性,如 title、date、tags、aliases、cssclasses,并支持自定义属性。
  • 标签:支持内联标签(#tag)和层级嵌套标签(#nested/tag),也可在 frontmatter 的 tags 中定义。
  • 注释:行内隐藏 %%...%%,以及整块隐藏段落。
  • Obsidian 专有格式:高亮 ==text==、LaTeX 数学(行内与块级)、Mermaid 图表(可将节点链接到 Obsidian 笔记)、脚注(含行内脚注)。

使用方式

技能给出的创建笔记工作流:

  1. 在文件顶部添加带属性的 frontmatter(如 title、tags、aliases)。
  2. 用标准 Markdown 组织结构,并配合上述 Obsidian 专有语法写内容。
  3. 用 wikilinks 链接库内相关笔记,外部 URL 用标准 Markdown 链接。
  4. 用 ![[embed]] 嵌入其他笔记、图片或 PDF 内容。
  5. 用 > [!type] 添加标注块以突出信息。
  6. 在 Obsidian 阅读视图中确认笔记渲染正确。

选择链接方式时:库内笔记用 [[wikilinks]](Obsidian 会自动跟踪重命名),外部 URL 用 [text](url)。

适用场景

适用于在 Obsidian 笔记库中撰写、编辑和整理 .md 文件,尤其是需要内链、嵌入、标注块、属性、标签、数学公式、Mermaid 图表或脚注的场景,例如项目笔记、会议记录、任务清单与知识库内容。

限制

该技能不覆盖标准 Markdown 基础语法,将其视为已知;资料提到更完整的属性类型、嵌入类型、标注块列表等细节见参考文档 PROPERTIES.md、EMBEDS.md、CALLOUTS.md,但未提供这些文档的具体内容。其它细节暂未提供。