name: obsidian-markdown category: 文档处理 description: 创建和编辑 Obsidian 风格的 Markdown，包含 wikilinks、embeds、callouts、properties 和其他 Obsidian 特定语法。在 Obsidian 中处理 .md 文件时使用，或当用户提到 wikilinks、callouts、frontmatter、tags、embeds 或 Obsidian 笔记时使用。
Obsidian 风格 Markdown
此技能使 Claude Code 能够创建和编辑有效的 Obsidian 风格 Markdown，包括 wikilinks、embeds、callouts、properties 以及所有相关语法。
何时使用此技能
- 在 Obsidian 保管库中处理 .md 文件
- 创建带有 wikilinks 或内部链接的笔记
- 为笔记、图像、音频或 PDF 添加嵌入
- 使用标注（信息框、警告、提示等）
- 以 YAML 格式管理 frontmatter/属性
- 处理标签和嵌套标签
- 创建块引用和块 ID
基本格式
段落和换行
段落之间用空行分隔。段落内的单行换行会被忽略，除非使用：
- 行尾两个空格
- 或使用
<br>进行显式换行
标题
# 标题 1
## 标题 2
### 标题 3
#### 标题 4
##### 标题 5
###### 标题 6
文本样式
**粗体文本**
*斜体文本*
***粗体加斜体***
~~删除线~~
==高亮文本==
内部链接（Wikilinks）
基本 Wikilinks
[[笔记名称]]
[[笔记名称|显示文本]]
[[文件夹/笔记名称]]
标题链接
[[笔记名称#标题]]
[[笔记名称#标题|显示文本]]
[[#当前笔记中的标题]]
块引用
[[笔记名称#^块-id]]
[[笔记名称#^块-id|显示文本]]
[[#^块-id]]
创建块 ID
在任何段落或列表项末尾添加块 ID：
这是一个可以引用的段落。 ^我的块-id
- 带有 ID 的列表项 ^列表块
嵌入
嵌入笔记
![[笔记名称]]
![[笔记名称#标题]]
![[笔记名称#^块-id]]
嵌入图像
![[image.png]]
![[image.png|400]]
![[image.png|400x300]]
嵌入音频
![[audio.mp3]]
嵌入 PDF
![[document.pdf]]
![[document.pdf#page=5]]
![[document.pdf#height=400]]
嵌入视频
![[video.mp4]]
标注
基本标注语法
> [!note]
> 这是一个注释标注。
> [!warning]
> 这是一个警告标注。
> [!tip] 自定义标题
> 此标注有自定义标题。
标注类型
| 类型 | 别名 | 描述 |
|---|---|---|
note |
默认蓝色信息框 | |
abstract |
summary, tldr |
摘要/概要 |
info |
信息 | |
todo |
任务/待办项 | |
tip |
hint, important |
有用提示 |
success |
check, done |
成功消息 |
question |
help, faq |
问题/常见问题 |
warning |
caution, attention |
警告消息 |
failure |
fail, missing |
失败消息 |
danger |
error |
错误/危险 |
bug |
错误报告 | |
example |
示例内容 | |
quote |
cite |
引用 |
可折叠标注
> [!note]+ 默认展开
> 初始可见的内容。
> [!note]- 默认折叠
> 初始隐藏的内容。
嵌套标注
> [!question] 标注可以嵌套吗？
> > [!answer] 是的！
> > 标注可以相互嵌套。
列表
无序列表
- 项目 1
- 项目 2
- 嵌套项目
- 另一个嵌套项目
- 项目 3
有序列表
1. 第一项
2. 第二项
1. 嵌套编号项
3. 第三项
任务列表
- [ ] 未完成任务
- [x] 已完成任务
- [ ] 另一个任务
代码块
内联代码
使用 `内联代码` 表示短代码片段。
围栏代码块
```javascript
function hello() {
console.log("Hello, world!");
}
```
支持的语言
Obsidian 支持许多语言的语法高亮，包括：
javascript, typescript, python, rust, go, java, c, cpp, csharp, ruby, php, html, css, json, yaml, markdown, bash, sql，以及更多。
表格
| 表头 1 | 表头 2 | 表头 3 |
|----------|:--------:|---------:|
| 左对齐 | 居中对齐 | 右对齐 |
| 对齐 | 对齐 | 对齐 |
数学（LaTeX）
内联数学
方程 $E = mc^2$ 很著名。
块数学
$$
\frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
$$
图表（Mermaid）
```mermaid
graph TD
A[开始] --> B{决策}
B -->|是| C[做某事]
B -->|否| D[做其他事]
C --> E[结束]
D --> E
```
脚注
这是一个带有脚注的句子。[^1]
[^1]: 这是脚注内容。
注释
%%
这是一个不会被渲染的注释。
%%
文本中的内联 %%注释%%。
属性（Frontmatter）
基本属性
---
title: 我的笔记标题
date: 2024-01-15
tags:
- tag1
- tag2
author: 张三
---
属性类型
| 类型 | 示例 |
|---|---|
| 文本 | title: 我的标题 |
| 数字 | rating: 5 |
| 复选框 | completed: true |
| 日期 | date: 2024-01-15 |
| 日期时间 | created: 2024-01-15T10:30:00 |
| 列表 | tags: [a, b, c] 或多行 |
| 链接 | related: "[[其他笔记]]" |
多值属性
---
tags:
- 项目
- 工作
- 重要
aliases:
- 我的别名
- 另一个名称
cssclasses:
- 宽页面
- 卡片
---
标签
内联标签
此笔记关于 #生产力 和 #工具。
嵌套标签
#项目/工作
#状态/进行中
#优先级/高
在 Frontmatter 中的标签
---
tags:
- 项目
- 项目/工作
- 状态/活跃
---
HTML 支持
Obsidian 支持 HTML 子集：
<div class="my-class">
自定义 HTML 内容
</div>
<details>
<summary>点击展开</summary>
隐藏内容在此
</details>
<kbd>Ctrl</kbd> + <kbd>C</kbd>
完整示例
---
title: 项目 Alpha 概述
date: 2024-01-15
tags:
- 项目
- 文档
status: active
---
# 项目 Alpha 概述
## 摘要
本文档概述了 **项目 Alpha** 的关键方面。相关材料见 [[项目 Alpha/资源]] 和 [[团队成员]]。
> [!info] 快速事实
> - 开始日期：2024 年 1 月
> - 团队规模：5 名成员
> - 状态：活跃
## 关键功能
1. [[功能 A]] - 核心功能
2. [[功能 B]] - 用户界面
3. [[功能 C]] - API 集成
### 功能 A 详情
主导我们方法的主要方程是 $f(x) = ax^2 + bx + c$。
![[功能-a-图表.png|500]]
> [!tip] 实施说明
> 参见 [[技术规范#^实施说明]] 获取实施详情。
## 任务
- [x] 初始规划 ^规划任务
- [ ] 开发阶段
- [ ] 测试阶段
- [ ] 部署
## 代码示例
```python
def process_data(input):
return transform(input)
架构
graph LR
A[输入] --> B[处理]
B --> C[输出]
笔记
此方法受 ==最新研究==[^1] 启发。
[^1]: Smith, J. (2024). 现代数据处理方法。
%% 待办：添加更多示例 下周与团队回顾 %%
#项目/alpha #文档
## 参考
- [Obsidian 格式化语法](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax)
- [高级格式化](https://help.obsidian.md/Editing+and+formatting/Advanced+formatting+syntax)
- [内部链接](https://help.obsidian.md/Linking+notes+and+files/Internal+links)
- [嵌入文件](https://help.obsidian.md/Linking+notes+and+files/Embed+files)
- [标注](https://help.obsidian.md/Editing+and+formatting/Callouts)
- [属性](https://help.obsidian.md/Editing+and+formatting/Properties)