Obsidian Markdown 语法完全指南：维基链接、嵌入、标注框与属性详解

obsidian-markdown by kepano/obsidian-skills

10,200 周安装量

17,300 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/kepano/obsidian-skills --skill obsidian-markdown

生产力

🇨🇳中文介绍

Obsidian Flavored Markdown 技能

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

工作流：创建 Obsidian 笔记

添加前置属性：在文件顶部添加包含属性（标题、标签、别名）的前置属性。所有属性类型请参阅 PROPERTIES.md。
编写内容：使用标准 Markdown 构建结构，并辅以下述 Obsidian 特有语法。
链接相关笔记：使用维基链接 ([[笔记名]]) 进行内部知识库连接，或使用标准 Markdown 链接处理外部 URL。
嵌入内容：使用 ![[嵌入]] 语法嵌入其他笔记、图像或 PDF 的内容。所有嵌入类型请参阅 EMBEDS.md。
添加标注框：使用 > [!类型] 语法为高亮信息添加标注框。所有标注框类型请参阅 CALLOUTS.md。
验证：确保笔记在 Obsidian 的阅读视图中能正确渲染。

在维基链接和 Markdown 链接之间选择时：对知识库内的笔记使用（Obsidian 会自动跟踪重命名），仅对外部 URL 使用。

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

内部链接（维基链接）

[[笔记名称]]                          链接到笔记
[[笔记名称|显示文本]]                 自定义显示文本
[[笔记名称#标题]]                     链接到标题
[[笔记名称#^块ID]]                    链接到块
[[#同一笔记内的标题]]                  同一笔记内的标题链接

通过在任何段落后附加 ^块ID 来定义块 ID：

此段落可以被链接到。 ^我的块ID

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

> 一个引用块

^引用ID

在任何维基链接前加上 ! 以将其内容内联嵌入：

![[笔记名称]]                         嵌入完整笔记
![[笔记名称#标题]]                    嵌入章节
![[image.png]]                        嵌入图像
![[image.png|300]]                    嵌入图像并指定宽度
![[document.pdf#page=3]]              嵌入 PDF 页面

音频、视频、搜索嵌入和外部图像的嵌入，请参阅 EMBEDS.md。

> [!note]
> 基础标注框。

> [!warning] 自定义标题
> 带有自定义标题的标注框。

> [!faq]- 默认折叠
> 可折叠的标注框（- 表示折叠，+ 表示展开）。

常见类型：note, tip, warning, info, example, quote, bug, danger, success, failure, question, abstract, todo。

包含别名、嵌套和自定义 CSS 标注框的完整列表，请参阅 CALLOUTS.md。

属性（前置属性）

---
title: 我的笔记
date: 2024-01-15
tags:
  - 项目
  - 进行中
aliases:
  - 替代名称
cssclasses:
  - 自定义类
---

默认属性：tags（可搜索的标签），aliases（用于链接建议的替代笔记名称），cssclasses（用于样式化的 CSS 类）。

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

#标签                    内联标签
#嵌套/标签               具有层级的嵌套标签

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

这是可见的文本 %%但这是隐藏的%%。

%%
整个块在阅读视图中是隐藏的。
%%

Obsidian 特有格式化

==高亮文本==                    高亮语法

数学公式（LaTeX）

行内公式：$e^{i\pi} + 1 = 0$

块公式：
$$
\frac{a}{b} = c
$$

```mermaid
graph TD
    A[开始] --> B{决策}
    B -->|是| C[执行此操作]
    B -->|否| D[执行彼操作]
```

要将 Mermaid 节点链接到 Obsidian 笔记，请添加 class 节点名称 internal-link;。

带脚注的文本[^1]。

[^1]: 脚注内容。

行内脚注。^[这是行内的。]

---
title: 项目 Alpha
date: 2024-01-15
tags:
  - 项目
  - 进行中
status: 进行中
---

# 项目 Alpha

本项目旨在使用现代技术 [[改进工作流程]]。

> [!important] 关键截止日期
> 第一个里程碑截止日期为 ==1月30日==。

## 任务

- [x] 初步规划
- [ ] 开发阶段
  - [ ] 后端实现
  - [ ] 前端设计

## 笔记

该算法使用 $O(n \log n)$ 排序。详情请见 [[算法笔记#排序]]。

![[架构图.png|600]]

已在 [[2024-01-10 会议笔记#决策]] 中审阅。

2026 年 1 月 20 日

🇺🇸English

Obsidian Flavored Markdown Skill

Create and edit valid Obsidian Flavored Markdown. Obsidian extends CommonMark and GFM with wikilinks, embeds, callouts, properties, comments, and other syntax. This skill covers only Obsidian-specific extensions -- standard Markdown (headings, bold, italic, lists, quotes, code blocks, tables) is assumed knowledge.

Workflow: Creating an Obsidian Note

Add frontmatter with properties (title, tags, aliases) at the top of the file. See PROPERTIES.md for all property types.
Write content using standard Markdown for structure, plus Obsidian-specific syntax below.
Link related notes using wikilinks ([[Note]]) for internal vault connections, or standard Markdown links for external URLs.
Embed content from other notes, images, or PDFs using the ![[embed]] syntax. See EMBEDS.md for all embed types.
Add callouts for highlighted information using > [!type] syntax. See CALLOUTS.md for all callout types.
Verify the note renders correctly in Obsidian's reading view.

When choosing between wikilinks and Markdown links: use [[wikilinks]] for notes within the vault (Obsidian tracks renames automatically) and [text](url) for external URLs only.

Internal Links (Wikilinks)

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

Define a block ID by appending ^block-id to any paragraph:

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

For lists and quotes, place the block ID on a separate line after the block:

> A quote block

^quote-id

Embeds

Prefix any wikilink with ! to embed its content inline:

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

See EMBEDS.md for audio, video, search embeds, and external images.

Callouts

> [!note]
> Basic callout.

> [!warning] Custom Title
> Callout with a custom title.

> [!faq]- Collapsed by default
> Foldable callout (- collapsed, + expanded).

Common types: note, tip, warning, info, example, quote, bug, danger, success, failure, question, abstract, .

See CALLOUTS.md for the full list with aliases, nesting, and custom CSS callouts.

Properties (Frontmatter)

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

Default properties: tags (searchable labels), aliases (alternative note names for link suggestions), cssclasses (CSS classes for styling).

See PROPERTIES.md for all property types, tag syntax rules, and advanced usage.

Comments

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

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

Obsidian-Specific Formatting

==Highlighted text==                   Highlight syntax

Math (LaTeX)

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

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

Diagrams (Mermaid)

```mermaid
graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Do this]
    B -->|No| D[Do that]
```

To link Mermaid nodes to Obsidian notes, add class NodeName internal-link;.

Footnotes

Text with a footnote[^1].

[^1]: Footnote content.

Inline footnote.^[This is inline.]

Complete Example

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

References

Weekly Installs

9.6K

Repository

kepano/obsidian-skills

GitHub Stars

16.9K

First Seen

Jan 20, 2026

Security Audits

Gen Agent Trust HubPass SocketPass SnykPass

Installed on

opencode8.8K

codex8.5K

gemini-cli8.5K

github-copilot8.1K

cursor7.9K

amp7.7K

Python PDF处理教程：合并拆分、提取文本表格、创建PDF文件

52,000 周安装