Document editor

Callout syntax

`> [!note]` form. Supports note / tip / warning / danger / success.

What is a callout

A callout is a semantic upgrade of the blockquote (>) — declare a type on the first line with [!type] and the renderer turns it into a colored, icon-prefixed box. Visually louder than a plain quote, great for risks, TODOs, key takeaways.

Kition’s callout syntax is fully compatible with Obsidian and GitHub Flavored Markdown — the same content roundtrips across all three.

Basic syntax

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

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

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

Available types

  • note — blue default, neutral info
  • tip — green, best practices or hard-won lessons
  • warning — yellow, careful but not fatal
  • danger — red, irreversible or destructive
  • success — green, confirms something landed
  • important — purple, key takeaway (GFM-compatible alias)

Advanced usage

Callouts fold — add + after the type for default-open, - for default-closed. Useful for long checklists you want collapsed by default and one-click expanded.

The body accepts full Markdown — lists, code blocks, tables, wikilinks, even nested callouts work.

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

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

When to use what

  • Tutorials: use warning for "watch out" steps, tip for best practices
  • RFCs: use danger for risk sections, success for acceptance criteria
  • Meeting notes: important for decisions, note for open questions
  • Don’t over-use danger — colors lose meaning when everything is red

Related articles

Ready when you are.

Kition is a local-first AI workspace. Markdown documents, structured tables, and an AI agent — running on your own machine, against the model provider you choose.