Obsidian-Callouts引注

一、基本语法

Callout(标注框)是一种用于突出显示笔记中特定内容的 Markdown 扩展语法,常用于备注、提示、警告、引用和待办事项等场景。

基本格式:

1
2
> [!type] 标题(可选)
> 这里是正文内容。

语法组成:

  • >:Markdown 引用符号,每一行内容都需要添加。
  • [!type]:指定 Callout 的类型,决定标注框的图标和颜色。
  • 标题:可选,用于自定义标注框标题。
  • 正文:标注框中需要展示的具体内容。

二、常用 Callout 类型

Obsidian 内置了多种 Callout 类型,不同类型具有不同的颜色和语义。

语法 默认颜色 建议用途
[!note] 蓝色 普通备注、补充说明
[!info] 蓝色 信息说明、背景知识
[!todo] 青色 待办事项、未完成任务
[!tip] 绿色 技巧、经验、实用提示
[!success] 绿色 成功、完成、验证通过
[!warning] 黄色 警告、注意事项、潜在风险
[!failure] 红色 失败、错误、异常情况
[!danger] 红色 危险操作、严重风险
[!quote] 灰色 引用、摘录、观点

使用示例

1. 普通备注

1
2
> [!note] 注意事项
> 这里记录一些需要特别注意的信息。

2. 技巧提示

1
2
> [!tip] 使用技巧
> 合理使用 Callout,可以让长篇笔记的重点更加突出。

3. 风险警告

1
2
> [!warning] 操作警告
> 修改配置文件之前,建议先备份原始文件。

4. 待办事项

1
2
3
> [!todo] 待完成
> - [ ] 学习 Callout 的嵌套用法
> - [ ] 整理常用标注框模板

三、进阶技巧

1. 可折叠 Callout

在 Callout 类型后面添加 + 或 -,即可设置标注框的默认展开状态。

语法 默认状态 操作行为
[!note]+ 展开 点击后可以折叠
[!note]- 折叠 点击后可以展开

默认展开:

1
2
3
> [!note]+ 补充说明
> 这部分内容默认显示。
> 点击标题后可以将其折叠。

默认折叠:

1
2
3
> [!note]- 详细资料
> 这部分内容默认隐藏。
> 适合存放较长的补充信息。

2. 自定义标题

可以在 Callout 类型后面直接添加自定义标题,替换默认标题。

1
2
> [!tip] 我的小窍门
> 这里填写具体的技巧或经验。

如果不填写标题,则会显示该类型对应的默认名称。

3. Callout 嵌套

Callout 内部可以继续嵌套其他 Callout,用于组织具有层级关系的信息。

1
2
3
4
5
> [!note] 主标注框
> 这是外层内容。
>
> > [!warning] 注意事项
> > 这是嵌套在内部的警告内容。

嵌套时需要增加引用符号的层级,例如外层使用 >,内层使用 >>。

四、实际使用建议

为了让 Obsidian 笔记保持统一,建议根据内容语义选择 Callout,而不是单纯为了颜色而使用。

内容类型 推荐语法
核心结论、重要观点 [!abstract]
普通备注 [!note]
背景知识、补充说明 [!info]
经验技巧、最佳实践 [!tip]
待办事项 [!todo]
成功验证、实验结果 [!success]
注意事项、潜在问题 [!warning]
错误案例、失败原因 [!failure]
高风险操作 [!danger]
名言、原文摘录 [!quote]

[!tip] 使用建议 对于技术笔记,可以重点使用 note、info、tip、warning 和 danger。

  • note:记录一般说明。

  • info:解释背景原理。

  • tip:记录实践经验。

  • warning:提醒容易忽略的问题。

  • danger:标记可能造成严重后果的操作。

五、补充说明

Obsidian 除了内置 Callout 类型,还支持通过主题或 CSS 自定义标注框的样式。

另外,Callout 类型名称通常不区分大小写,部分类型还可以通过别名使用。

例如:

1
2
> [!important] 重要内容
> 这里是一条重要说明。

如果希望进一步了解全部类型、别名及自定义方式,可以参考 Obsidian 官方文档:

Obsidian 官方文档:Callouts

[!quote] 核心记忆 Callout 的核心语法是 > [!type],其中 type 决定标注框的语义和样式;添加 + 或 - 可以控制默认展开状态;在类型后添加文字可以自定义标题。

Licensed under CC BY-NC-SA 4.0