用途
Obsidian Flavored Markdown 技能用于创建和编辑有效的 Obsidian 风格 Markdown。Obsidian 在 CommonMark 和 GFM 基础上扩展了 wikilinks、嵌入、标注、属性、注释等语法。该技能只覆盖 Obsidian 专有扩展,标准 Markdown(标题、粗体、斜体、列表、引用、代码块、表格)属于预设知识。
主要能力
内部链接(Wikilinks)
[[Note Name]]链接到笔记[[Note Name|Display Text]]自定义显示文本[[Note Name#Heading]]链接到标题[[Note Name#^block-id]]链接到块[[#Heading in same note]]同笔记标题链接
块 ID 定义方式:在任意段落末尾附加 ^block-id,例如 This paragraph can be linked to. ^my-block-id。对于列表和引用,将块 ID 放在块之后单独一行。
嵌入
在 wikilink 前加 ! 可将其内容内联嵌入:
![[Note Name]]嵌入完整笔记![[Note Name#Heading]]嵌入章节![[image.png]]嵌入图片![[image.png|300]]按宽度嵌入图片![[document.pdf#page=3]]嵌入 PDF 页面
标注(Callouts)
> [!note]
> Basic callout.
> [!warning] Custom Title
> Callout with a custom title.
> [!faq]- Collapsed by default
> Foldable callout (- collapsed, + expanded).
常见类型:note、tip、warning、info、example、quote、bug、danger、success、failure、question、abstract、todo。
属性(Frontmatter)
---
title: My Note
date: 2024-01-15
tags:
- project
- active
aliases:
- Alternative Name
cssclasses:
- custom-class
---
默认属性:tags(可搜索标签)、aliases(用于链接建议的替代笔记名)、cssclasses(用于样式的 CSS 类)。
标签
#tag行内标签#nested/tag带层级的嵌套标签
标签可包含字母、数字(不能作为首字符)、下划线、连字符和正斜杠。标签也可在 frontmatter 的 tags 属性中定义。
注释
这是可见的 %%而这是隐藏的%% 文本。%%整块内容在阅读视图中隐藏。%%
Obsidian 专有格式
==Highlighted text==高亮语法
数学(LaTeX)
- 行内:
$e^{i\pi} + 1 = 0$ - 块级:
$$ \frac{a}{b} = c $$
图表(Mermaid)
graph TD
A[Start] --> B{Decision}
B -->|Yes| C[Do this]
B -->|No| D[Do that]
要让 Mermaid 节点链接到 Obsidian 笔记,添加 class NodeName internal-link;。
脚注
- 文本脚注:
Text with a footnote[^1].与[^1]: Footnote content. - 行内脚注:
Inline footnote.^[This is inline.]
使用方式
创建工作流程:在文件顶部添加带属性的 frontmatter(title、tags、aliases),使用标准 Markdown 编写结构内容并结合上述 Obsidian 专有语法;用 wikilinks([[Note]])链接库内相关笔记或用标准 Markdown 链接外部 URL;用 ![[embed]] 语法嵌入其他笔记、图片或 PDF 的内容;用 > [!type] 语法添加标注;最后在 Obsidian 阅读视图中验证笔记渲染是否正确。
在 wikilinks 和 Markdown 链接之间选择时:库内笔记使用 [[wikilinks]](Obsidian 会自动跟踪重命名),外部 URL 使用 [text](url)。
完整示例
---
title: Project Alpha
date: 2024-01-15
tags:
- project
- active
status: in-progress
---
# Project Alpha
This project aims to [[improve workflow]] using modern techniques.
> [!important] Key Deadline
> The first milestone is due on ==January 30th==.
## Tasks
- [x] Initial planning
- [ ] Development phase
- [ ] Backend implementation
- [ ] Frontend design
## Notes
The algorithm uses $O(n \log n)$ sorting. See [[Algorithm Notes#Sorting]] for details.
![[Architecture Diagram.png|600]]
Reviewed in [[Meeting Notes 2024-01-10#Decisions]].
适用场景
适用于在 Obsidian 库中处理 .md 文件,需要创建或编辑符合 Obsidian 语法的笔记时使用,包括建立笔记间链接、嵌入内容、添加标注和属性等。
限制
该技能仅覆盖 Obsidian 专有扩展语法,标准 Markdown 知识不在其范围内。关于音频、视频、搜索嵌入和外部图片,以及属性完整类型、标签语法规则、标注完整列表与嵌套、自定义 CSS 标注等高级用法,资料中仅指向 EMBEDS.md、PROPERTIES.md、CALLOUTS.md 等文件,未提供其具体内容。具体版本要求、平台限制和价格信息暂未提供。