obsidian-markdown

obsidian-markdown

热门

创建和编辑Obsidian风味Markdown,支持维基链接、嵌入、标注、属性及其他Obsidian特有语法。适用于处理Obsidian中的.md文件,或当用户提及维基链接、标注、frontmatter、标签、嵌入或Obsidian笔记时使用。

3.6万Star
2792Fork
更新于 2026/6/21
SKILL.md
readonly只读
name
obsidian-markdown
description

创建和编辑Obsidian风味Markdown,支持维基链接、嵌入、标注、属性及其他Obsidian特有语法。适用于处理Obsidian中的.md文件,或当用户提及维基链接、标注、frontmatter、标签、嵌入或Obsidian笔记时使用。

Obsidian风味Markdown技能

创建和编辑有效的Obsidian风味Markdown。Obsidian在CommonMark和GFM基础上扩展了维基链接、嵌入、标注、属性、注释等语法。本技能仅涵盖Obsidian特有的扩展——标准Markdown(标题、粗体、斜体、列表、引用、代码块、表格)视为已知知识。

工作流程:创建Obsidian笔记

  1. 添加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]]                          链接到笔记
[[Note Name|Display Text]]             自定义显示文本
[[Note Name#Heading]]                  链接到标题
[[Note Name#^block-id]]                链接到块
[[#Heading in same note]]              同一笔记内的标题链接

通过在任何段落后附加^block-id来定义块ID:

此段落可被链接。^my-block-id

对于列表和引用,将块ID放在块后的单独一行:

> 引用块

^quote-id

嵌入

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

![[Note Name]]                         嵌入完整笔记
![[Note Name#Heading]]                 嵌入章节
![[image.png]]                         嵌入图片
![[image.png|300]]                     嵌入图片并指定宽度
![[document.pdf#page=3]]               嵌入PDF页面

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

标注

> [!note]
> 基本标注。

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

> [!faq]- 默认折叠
> 可折叠标注(- 折叠,+ 展开)。

常见类型:notetipwarninginfoexamplequotebugdangersuccessfailurequestionabstracttodo

完整列表(含别名、嵌套和自定义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                    内联标签
#nested/tag             带层次结构的嵌套标签

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

注释

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

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

Obsidian特有格式

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

数学(LaTeX)

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

块级:
$$
\frac{a}{b} = c
$$

图表(Mermaid)

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

要将Mermaid节点链接到Obsidian笔记,请添加class NodeName internal-link;

脚注

带脚注的文本[^1]。

[^1]: 脚注内容。

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

完整示例

---
title: 项目Alpha
date: 2024-01-15
tags:
  - project
  - active
status: in-progress
---

# 项目Alpha

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

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

## 任务

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

## 笔记

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

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

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

参考