obsidian-markdown

Obsidian Flavored Markdown 技能

创建和编辑有效的 Obsidian Flavored Markdown。Obsidian 在 CommonMark 和 GFM 的基础上扩展了维基链接、嵌入、提示框、属性、注释及其他语法。本技能仅涵盖 Obsidian 特有的扩展语法——标准 Markdown（标题、粗体、斜体、列表、引用、代码块、表格）视为已掌握。

工作流：创建 Obsidian 笔记

1. 在文件顶部添加包含属性（title、tags、aliases）的 frontmatter。所有属性类型请参阅 PROPERTIES.md。
2. 使用标准 Markdown 编写内容结构，并结合下文介绍的 Obsidian 特有语法。
3. 使用维基链接（[[Note]]）关联知识库中的笔记，或使用标准 Markdown 链接指向外部 URL。
4. 使用 ![[embed]] 语法嵌入其他笔记、图像或 PDF 中的内容。所有嵌入类型请参阅 EMBEDS.md。
5. 使用 > [!type] 语法添加提示框，以突出显示信息。所有提示框类型请参阅 CALLOUTS.md。
6. 在 Obsidian 的阅读视图中确认笔记渲染正确。

选择维基链接还是 Markdown 链接时：知识库中的笔记使用 [[wikilinks]]（Obsidian 会自动跟踪重命名），外部 URL 则仅使用 [text](url)。

内部链接（维基链接）

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

嵌入

在任意维基链接前加上 !，即可在行内嵌入其内容：

![[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 知识库结构时，始终默认使用 llm-wiki 结构（包含 SCHEMA.md、index.md、log.md、raw/、topics/、entities/、concepts/、comparisons/、queries/）。详情请参阅 llm-wiki 技能。

参考资料

• Obsidian Flavored Markdown
• 内部链接
• 嵌入文件
• 提示框
• 属性