obsidian-markdown 是做什么的?
创建和编辑 Obsidian 风味 Markdown,支持维基链接、嵌入、标注、属性及其他 Obsidian 特定语法。适用于在 Obsidian 中操作 .md 文件,或当用户提及维基链接、标注、frontmatter、标签、嵌入或 Obsidian 笔记时使用。
关键语法特性
以下是在 Obsidian 中使用的标准 Markdown 语法扩展:
维基链接(Wikilinks)
- 内部链接:
[[笔记名称]] - 带显示文本的链接:
[[笔记名称|显示文本]] - 链接到标题:
[[笔记名称#标题]] - 链接到块:
[[笔记名称#^块ID]]
嵌入(Embeds)
- 嵌入笔记:
![[笔记名称]] - 嵌入图片:
![[图片.png]] - 嵌入音频或视频:
![[音频.mp3]]、![[视频.mp4]] - 嵌入特定部分:
![[笔记名称#标题]]
标注(Callouts)
> [!note] 标题
> 内容
常见类型包括:note、abstract、info、tip、success、question、warning、failure、danger、bug、example、quote
标注还支持:
- 可折叠标注:
> [!faq]- 可折叠标题 - 嵌套标注
- 自定义图标(需要主题/插件)
属性(Properties / Frontmatter)
---
title: 笔记标题
date: 2024-01-01
tags:
- 标签1
- 标签2
aliases:
- 别名1
cssclass: 自定义类
---
注释(Comments)
%% 这是用户不可见的注释 %%
标签(Tags)
- 行内标签:
#标签名 - 嵌套标签:
#项目/子项目 - 属性中的标签(见上方属性示例)
使用指南
- 检测需求:当用户提及“维基链接”、“标注”、“Obsidian”、“双链”或“嵌入”时,使用本技能。
- 应用格式:根据上下文选择适当的 Obsidian 特定语法。
- 验证输出:确保生成的 Markdown 在 Obsidian 中能正确渲染。
- 避免第三方语法:不要使用需要特定插件或主题才能生效的语法。
最佳实践
- 对笔记之间链接使用维基链接,而非标准 Markdown 链接。
- 使用嵌入来整合相关内容,而非复制粘贴。
- 使用标注来结构化笔记中的提示、警告或引用。
- 使用属性(YAML frontmatter)存储元数据,而非在正文中创建自定义格式。