obsidian-markdown

Obsidian Flavored Markdown 技能

创建并编辑有效的 Obsidian Flavored Markdown。Obsidian 在 CommonMark 和 GFM 的基础上扩展了 wikilink、嵌入、标注、属性和注释等语法。本技能仅涵盖 Obsidian 特有的扩展 —— 标准 Markdown（标题、粗体、斜体、列表、引用、代码块、表格）属于默认已掌握的知识。

何时使用

• 在撰写或编辑面向 Obsidian 的 Markdown 笔记时使用。
• 在任务涉及 wikilink、嵌入、标注、frontmatter 属性或 Obsidian 特有语法时使用。
• 在用户希望笔记能在 Obsidian 仓库中正确渲染时使用。

工作流：创建 Obsidian 笔记

1. 添加 frontmatter：在文件顶部添加包含属性（title、tags、aliases）的 frontmatter。所有属性类型见 PROPERTIES.md。
2. 撰写内容：使用标准 Markdown 构建结构，并配合下文介绍的 Obsidian 特有语法。
3. 链接相关笔记：使用 wikilink（[[Note]]）建立仓库内部连接，或使用标准 Markdown 链接指向外部 URL。
4. 嵌入内容：使用 ![[embed]] 语法嵌入其他笔记、图片或 PDF 中的内容。所有嵌入类型见 EMBEDS.md。
5. 添加标注：使用 > [!type] 语法突出显示信息。所有标注类型见 CALLOUTS.md。
6. 验证：确认笔记在 Obsidian 的阅读视图中正确渲染。

在 wikilink 和 Markdown 链接之间选择时：仓库内的笔记使用 [[wikilinks]]（Obsidian 会自动跟踪重命名），仅外部 URL 使用普通 Markdown 链接。

内部链接（Wikilink）

[[Note Name]]                          Link to note
[[Note Name|Display Text]]             Custom display text
[[Note Name#Heading]]                  Link to heading
[[Note Name#^block-id]]                Link to block
[[#Heading in same note]]              Same-note heading link

在任何段落末尾追加 ^block-id 即可定义块 ID：

This paragraph can be linked to. ^my-block-id

对于列表和引用，将块 ID 放在该块之后的单独一行：

> A quote block

^quote-id

嵌入

在任何 wikilink 前加上 ! 即可将其内容内联嵌入：

![[Note Name]]                         Embed full note
![[Note Name#Heading]]                 Embed section
![[image.png]]                         Embed image
![[image.png|300]]                     Embed image with width
![[document.pdf#page=3]]               Embed PDF page

音频、视频、搜索嵌入和外部图片见 EMBEDS.md。

标注

> [!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。

包含别名、嵌套和自定义 CSS 标注的完整列表见 CALLOUTS.md。

属性（Frontmatter）

---
title: My Note
date: 2024-01-15
tags:
  - project
  - active
aliases:
  - Alternative Name
cssclasses:
  - custom-class
---

默认属性：tags（可搜索的标签）、aliases（用于链接建议的备选笔记名）、cssclasses（用于样式的 CSS 类）。

所有属性类型、标签语法规则和高级用法见 PROPERTIES.md。

标签

#tag                    Inline tag
#nested/tag             Nested tag with hierarchy

标签可以包含字母、数字（不能作为首字符）、下划线、连字符和正斜杠。标签也可以在 frontmatter 的 tags 属性中定义。

注释

This is visible %%but this is hidden%% text.

%%
This entire block is hidden in reading view.
%%

Obsidian 特有格式

==Highlighted text==                   Highlight syntax

数学（LaTeX）

Inline: $e^{i\pi} + 1 = 0$

Block:
$$
\frac{a}{b} = c
$$

图表（Mermaid）

```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.]

完整示例

---
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 Flavored Markdown
• Internal links
• Embed files
• Callouts
• Properties

限制

• 仅当任务明确符合上述范围时才使用本技能。
• 不要将输出视为特定环境验证、测试或专家评审的替代品。
• 如果缺少必要的输入、权限、安全边界或成功标准，请停止并请求澄清。