obsidian-markdown

Obsidian Flavored Markdown 技能

此技能使 Claude Code 能够创建和编辑有效的 Obsidian Flavored Markdown，包括所有 Obsidian 特有的语法扩展。

概述

Obsidian 结合使用多种 Markdown 变体：

• CommonMark
• GitHub Flavored Markdown
• LaTeX 用于数学公式
• Obsidian 特有的扩展（wikilinks、callouts、embeds 等）

基本格式

段落与换行

This is a paragraph.

This is another paragraph (blank line between creates separate paragraphs).

For a line break within a paragraph, add two spaces at the end  
or use Shift+Enter.

标题

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

文本格式

样式	语法	示例	输出
粗体	**text** 或 __text__	**Bold**	Bold
斜体	*text* 或 _text_	*Italic*	Italic
粗体 + 斜体	***text***	***Both***	Both
删除线	~~text~~	~~Striked~~	Striked
高亮	==text==	==Highlighted==	==Highlighted==
行内代码	`code`	`code`	code

转义格式

使用反斜杠转义特殊字符：

\*This won't be italic\*
\#This won't be a heading
1\. This won't be a list item

常见需要转义的字符：\*、\_、\#、\`、\|、\~

内部链接（Wikilinks）

基本链接

[[Note Name]]
[[Note Name.md]]
[[Note Name|Display Text]]

链接到标题

[[Note Name#Heading]]
[[Note Name#Heading|Custom Text]]
[[#Heading in same note]]
[[##Search all headings in vault]]

链接到块

[[Note Name#^block-id]]
[[Note Name#^block-id|Custom Text]]

在段落末尾添加 ^block-id 来定义块 ID：

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

对于列表和引用，将块 ID 添加在单独的一行：

> This is a quote
> With multiple lines

^quote-id

搜索链接

[[##heading]]     Search for headings containing "heading"
[[^^block]]       Search for blocks containing "block"

Markdown 风格链接

[Display Text](Note%20Name.md)
[Display Text](Note%20Name.md#Heading)
[Display Text](https://example.com)
[Note](obsidian://open?vault=VaultName&file=Note.md)

注意：在 Markdown 链接中，空格必须 URL 编码为 %20。

嵌入

嵌入笔记

![[Note Name]]
![[Note Name#Heading]]
![[Note Name#^block-id]]

嵌入图片

![[image.png]]
![[image.png|640x480]]    Width x Height
![[image.png|300]]        Width only (maintains aspect ratio)

外部图片

![Alt text](https://example.com/image.png)
![Alt text|300](https://example.com/image.png)

嵌入音频

![[audio.mp3]]
![[audio.ogg]]

嵌入 PDF

![[document.pdf]]
![[document.pdf#page=3]]
![[document.pdf#height=400]]

嵌入列表

![[Note#^list-id]]

其中列表已通过块 ID 定义：

- Item 1
- Item 2
- Item 3

^list-id

嵌入搜索结果

```query
tag:#project status:done
```

Callouts

基本 Callout

> [!note]
> This is a note callout.

> [!info] Custom Title
> This callout has a custom title.

> [!tip] Title Only

可折叠 Callout

> [!faq]- Collapsed by default
> This content is hidden until expanded.

> [!faq]+ Expanded by default
> This content is visible but can be collapsed.

嵌套 Callout

> [!question] Outer callout
> > [!note] Inner callout
> > Nested content

支持的 Callout 类型

类型	别名	描述
note	-	蓝色，铅笔图标
abstract	summary、tldr	青色，剪贴板图标
info	-	蓝色，信息图标
todo	-	蓝色，复选框图标
tip	hint、important	青色，火焰图标
success	check、done	绿色，对勾图标
question	help、faq	黄色，问号
warning	caution、attention	橙色，警告图标
failure	fail、missing	红色，X 图标
danger	error	红色，闪电图标
bug	-	红色，虫子图标
example	-	紫色，列表图标
quote	cite	灰色，引用图标

自定义 Callout（CSS）

.callout[data-callout="custom-type"] {
  --callout-color: 255, 0, 0;
  --callout-icon: lucide-alert-circle;
}

列表

无序列表

- Item 1
- Item 2
  - Nested item
  - Another nested
- Item 3

* Also works with asterisks
+ Or plus signs

有序列表

1. First item
2. Second item
   1. Nested numbered
   2. Another nested
3. Third item

1) Alternative syntax
2) With parentheses

任务列表

- [ ] Incomplete task
- [x] Completed task
- [ ] Task with sub-tasks
  - [ ] Subtask 1
  - [x] Subtask 2

引用

> This is a blockquote.
> It can span multiple lines.
>
> And include multiple paragraphs.
>
> > Nested quotes work too.

代码

行内代码

Use `backticks` for inline code.
Use double backticks for ``code with a ` backtick inside``.

代码块

```
Plain code block
```

```javascript
// Syntax highlighted code block
function hello() {
  console.log("Hello, world!");
}
```

```python
# Python example
def greet(name):
    print(f"Hello, {name}!")
```

嵌套代码块

在外层块使用更多的反引号或波浪号：

````markdown
Here's how to create a code block:
```js
console.log("Hello")
```
````

表格

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

对齐

| Left     | Center   | Right    |
|:---------|:--------:|---------:|
| Left     | Center   | Right    |

在表格中使用管道符

使用反斜杠转义管道符：

| Column 1 | Column 2 |
|----------|----------|
| [[Link\|Display]] | ![[Image\|100]] |

数学公式（LaTeX）

行内数学

This is inline math: $e^{i\pi} + 1 = 0$

块级数学

$$
\begin{vmatrix}
a & b \\
c & d
\end{vmatrix} = ad - bc
$$

常见数学语法

$x^2$              Superscript
$x_i$              Subscript
$\frac{a}{b}$      Fraction
$\sqrt{x}$         Square root
$\sum_{i=1}^{n}$   Summation
$\int_a^b$         Integral
$\alpha, \beta$    Greek letters

图表（Mermaid）

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

序列图

```mermaid
sequenceDiagram
    Alice->>Bob: Hello Bob
    Bob-->>Alice: Hi Alice
```

在图表中链接

```mermaid
graph TD
    A[Biology]
    B[Chemistry]
    A --> B
    class A,B internal-link;
```

脚注

This sentence has a footnote[^1].

[^1]: This is the footnote content.

You can also use named footnotes[^note].

[^note]: Named footnotes still appear as numbers.

Inline footnotes are also supported.^[This is an inline footnote.]

注释

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

%%
This entire block is hidden.
It won't appear in reading view.
%%

分隔线

---
***
___
- - -
* * *

属性（Frontmatter）

属性使用位于笔记开头的 YAML frontmatter：

---
title: My Note Title
date: 2024-01-15
tags:
  - project
  - important
aliases:
  - My Note
  - Alternative Name
cssclasses:
  - custom-class
status: in-progress
rating: 4.5
completed: false
due: 2024-02-01T14:30:00
---

属性类型

类型	示例
文本	title: My Title
数字	rating: 4.5
复选框	completed: true
日期	date: 2024-01-15
日期与时间	due: 2024-01-15T14:30:00
列表	tags: [one, two] 或 YAML 列表
链接	related: "[[Other Note]]"

默认属性

• tags - 笔记标签
• aliases - 笔记的替代名称
• cssclasses - 应用于笔记的 CSS 类

标签

#tag
#nested/tag
#tag-with-dashes
#tag_with_underscores

In frontmatter:
---
tags:
  - tag1
  - nested/tag2
---

标签可以包含：

• 字母（任何语言）
• 数字（不能作为首字符）
• 下划线 _
• 连字符 -
• 正斜杠 /（用于嵌套）

HTML 内容

Obsidian 支持在 Markdown 中使用 HTML：

<div class="custom-container">
  <span style="color: red;">Colored text</span>
</div>

<details>
  <summary>Click to expand</summary>
  Hidden content here.
</details>

<kbd>Ctrl</kbd> + <kbd>C</kbd>

完整示例

---
title: Project Alpha
date: 2024-01-15
tags:
  - project
  - active
status: in-progress
priority: high
---

# Project Alpha

## Overview

This project aims to [[improve workflow]] using modern techniques.

> [!important] Key Deadline
> The first milestone is due on ==January 30th==.

## Tasks

- [x] Initial planning
- [x] Resource allocation
- [ ] Development phase
  - [ ] Backend implementation
  - [ ] Frontend design
- [ ] Testing
- [ ] Deployment

## Technical Notes

The main algorithm uses the formula $O(n \log n)$ for sorting.

```python
def process_data(items):
    return sorted(items, key=lambda x: x.priority)
```

## Architecture

```mermaid
graph LR
    A[Input] --> B[Process]
    B --> C[Output]
    B --> D[Cache]
```

## Related Documents

- ![[Meeting Notes 2024-01-10#Decisions]]
- [[Budget Allocation|Budget]]
- [[Team Members]]

## References

For more details, see the official documentation[^1].

[^1]: https://example.com/docs

%%
Internal notes:
- Review with team on Friday
- Consider alternative approaches
%%

参考资料

• 基本格式语法
• 高级格式语法
• Obsidian 风格的 Markdown
• 内部链接
• 嵌入文件
• 提示框
• 属性

---

注意事项

• 围栏代码块中的 Wikilink 会按字面文本渲染（这是正确的），但会被索引为链接 — 搜索和关系图视图会显示它们之间的关联，尽管它们不会以链接形式渲染。
• Frontmatter 列表值 tags: [a, b]（流式格式）在 UI 中不会自动补全；YAML 块格式 tags:\n - a\n - b 则可以 — 两者语义相同，但编辑器支持不同。
• 折叠提示框要求每一行内容（包括空行）都以 > 为前缀 — 少一个 > 就会导致折叠失效，且不会报错。
• 块 ID（^id）的作用范围限于单个文件 — 跨文件引用时需要同时指定文件名和块 ID：[[Other^id]]。
• LaTeX $$ ... $$ 前后都需要空行 — 如果没有空行，Obsidian 会将美元符号按字面文本渲染。
• 嵌入 ![[Note#Heading]] 对标题名称敏感 — 重命名标题会悄无声息地破坏所有嵌入内容；名称不会自动同步更新。