Post

Obsidian Callout 与排版语法参考

Obsidian Callout 标注类型、语法技巧与图片排版速查。

Obsidian Callout 与排版语法参考

Obsidian Callout (标注) 与排版语法参考

1. GitHub 标准兼容 (5种基础类型)

这些是 GitHub 和大多数 Markdown 平台通用的类型。

NOTE

NOTE (笔记) 蓝色。用于强调普通信息或补充说明。 别名:info

TIP

TIP (提示) 绿色。用于提供可选的建议或更好的做法。 别名:hint, important

IMPORTANT

IMPORTANT (重要) 紫色/青色(视主题而定)。关键信息,用户必须知道才能成功完成任务。

WARNING

WARNING (警告) 橙色。提示可能存在的问题或不当操作的后果。 别名:caution, attention

CAUTION

CAUTION (慎重) 红色。提示严重后果(如数据丢失)。 注意:在 Obsidian 默认主题中,Caution 有时会与 Warning 共享样式,具体取决于主题设置。


2. Obsidian 原生扩展类型

Obsidian 内置了更多丰富的类型,支持多种别名(不区分大小写)。

🔵 蓝色系:信息与摘要

ABSTRACT

ABSTRACT (摘要) 用于总结或“太长不看”。 别名:summary, tldr

TODO

TODO (待办) 用于列出任务清单。

🟢 绿色系:成功与完成

SUCCESS

SUCCESS (成功) 用于表示操作成功或任务完成。 别名:check, done

🟡 黄/橙色系:疑问与示例

QUESTION

QUESTION (疑问) 用于提出问题或帮助文档。 别名:help, faq

EXAMPLE

EXAMPLE (示例) 用于展示案例或举例说明(通常显示为紫色或独立颜色)。

🔴 红色系:错误与 Bug

FAILURE

FAILURE (失败) 用于表示失败或缺失信息。 别名:fail, missing

DANGER

DANGER (危险) 比 Warning 更严重的错误或报错信息。 别名:error

BUG

BUG (漏洞) 专门用于标记程序 Bug。

🔘 灰色系:引用

QUOTE

QUOTE (引用) 用于引用名言或段落,比普通 > 引用更正式。 别名:cite


3. 语法技巧

自定义标题

在类型后面直接写上想要的标题。

这里写你自定义的标题

内容在这里。

可折叠 Callout (Folding)

  • +:默认展开
  • -:默认折叠

嵌套使用

使用多重 > 符号。

外层笔记

这是一层。

[!warning] 内层警告 这是一个嵌套在里面的警告。


4. 图片排版回顾 (需配合 CSS)

前提:已安装 image-layout.css 片段

语法:

  • \!\[\[图片.png|right]] : 右浮动
  • \!\[\[图片.png|left]] : 左浮动
  • \!\[\[图片.png|center]] : 居中

最佳实践示例 (写在段落开头):

图片右环绕写法

Obsidian-templates-20251219154631150.png这是紧接着图片的正文内容。请务必把图片代码放在段落的最开头,并且不要换行,这样在实时预览模式下也能方便地选中文字,且排版最整齐。

Obsidian 浮动 Callout 使用指南 (无表格冲突版)

该版本使用了 连字符 - 语法,彻底解决了使用竖线 | 时编辑器误判为表格的问题。

1. 基础语法

规则> [!类型-方向] 标题

语法 效果 说明
> [!note-right] 🟦 蓝色靠右 普通笔记,默认宽度 40%
> [!tip-right] 🟩 绿色靠右 提示/技巧,保持绿色
> [!warning-left] 🟧 橙色靠左 警告信息,靠左显示

2. 宽度调整语法

规则> [!类型-方向-尺寸] 标题

语法 宽度 适用场景
> [!note-right-sm] 25% (窄) 短评、小贴士、单词解释
> [!note-right-lg] 60% (宽) 长段落补充,占据主导地位

3. 实战示例

示例 A:靠右的提示 (标准)

💡 这是一个提示

因为使用了 -right 后缀,它不会干扰表格语法。 颜色依然保持绿色的 Tip 风格。

这里是正文内容。请注意,Callout 代码块必须写在这段文字的上方。这样文字会自动填充到左侧的空白区域,形成环绕效果。


示例 B:靠左的警告 (窄版)

⚠️ 注意

这是一个窄一点的警告框,适合放少量文字。

这里是正文内容。你会发现警告框浮动在左侧,宽度只有 25%,正文占据了右侧大部分空间。


示例 C:靠右的笔记 (宽版)

📝 扩展阅读

这是一个比较宽的侧边栏(60%)。 当你的侧边栏内容比较多,或者包含代码块时,使用 -lg 后缀会更合适。

这里是正文内容。由于侧边栏占了 60%,正文只剩下左侧的一小条空间,这种布局适合“左文右图”或者“左文右注解”的结构。

This post is licensed under CC BY 4.0 by the author.