文档编辑器

Callout 语法

`> [!note]` 形式,支持 note / tip / warning / danger / success。

什么是 Callout

Callout 是引用块(>)的语义增强版 — 第一行用 [!type] 声明类型,渲染时会变成带图标和颜色的提示框。视觉上比普通引用更突出,适合放风险、TODO、关键结论。

Kition 的 callout 语法和 Obsidian / GitHub Flavored Markdown 完全兼容 — 你写的内容可以无缝在三个工具间复用。

基础语法

> [!NOTE] 标题(可选)
> 内容第一行
> 内容第二行

> [!WARNING]
> 注意:这是个警告框

> [!SUCCESS] 完成
> 操作成功

可用类型

  • note — 默认蓝色,普通信息提示
  • tip — 绿色,最佳实践或经验
  • warning — 黄色,需要注意但不致命
  • danger — 红色,操作不可逆 / 破坏性
  • success — 绿色,确认事情已完成
  • important — 紫色,关键信息(GFM 兼容别名)

高级用法

Callout 可以折叠 — 在类型后加 + 默认展开、加 - 默认折叠。这对长清单尤其有用:默认折起来,需要时一键展开。

内部支持完整的 Markdown — 列表、代码块、表格、双链、甚至嵌套的 callout 都行。

> [!TIP]- 默认折叠:点开看完整命令
> ```bash
> kition export --format pdf --style academic
> ```

> [!DANGER] 删库三件套
> 1. 备份 `vault/Tables/*.kitable`
> 2. 关闭同步
> 3. 再删除文件
>
> 这一步错了没救。

什么时候用哪个

  • 写教程:步骤里的「小心」用 warning,「最佳实践」用 tip
  • 写 RFC:风险段落用 danger,验收标准用 success
  • 写会议纪要:决议用 important,疑问用 note
  • 别滥用 danger — 颜色失效是因为人眼会学会忽略它

相关文档

下载 Kition

本地优先的 AI 工作空间。Markdown 文档、结构化数据表、AI Agent,全部跑在你自己的电脑上。