151 lines
4.6 KiB
Markdown
151 lines
4.6 KiB
Markdown
---
|
|
title: 警告框与提示框演示
|
|
tags: 演示, Markdown, 警告框, 主题
|
|
---
|
|
|
|
# 警告框与提示框
|
|
|
|
本页展示 GitHub 警告框和 Obsidian 提示框的类型、标题、折叠、嵌套及正文格式。打开工作区写作模式查看效果；切换源码模式查看原始语法。
|
|
|
|
## 五种常用警告框
|
|
|
|
> [!NOTE]
|
|
> 记录补充信息：这份笔记中的内容都是功能演示，不会执行代码或调用模型。
|
|
|
|
> [!TIP] 小技巧：快速插入
|
|
> 点击编辑器顶部的“提示框”选择器，选择类型后替换模板内容。
|
|
|
|
> [!IMPORTANT] 保存与显示状态
|
|
> 点击标题展开或收起，只改变本次显示状态。要修改默认状态，请在源码中的类型标记后添加 `+` 或 `-`。
|
|
|
|
> [!WARNING] 修改前保留原文
|
|
> 在演示笔记中练习时，可以先复制一段内容；需要恢复时使用撤销。
|
|
|
|
> [!CAUTION] 需要重点关注的说明
|
|
> `CAUTION` 与 `WARNING` 使用同一警告配色。提示框是笔记内容，不是应用报错弹窗。
|
|
|
|
## 更多类型
|
|
|
|
> [!ABSTRACT] 本页摘要
|
|
> 类型区分语义，标题说明重点，正文保留详细信息。
|
|
|
|
> [!INFO] 环境信息
|
|
> 警告框的边框、标题和背景随主题变化。
|
|
|
|
> [!TODO] 待办
|
|
> - [ ] 展开下方折叠示例。
|
|
> - [ ] 切换深色主题。
|
|
> - [ ] 保存后重新打开本页。
|
|
|
|
> [!SUCCESS] 已完成
|
|
> 本段展示成功状态，不代表自动测试或实际任务已经完成。
|
|
|
|
> [!QUESTION] 可以嵌套吗？
|
|
> 可以。增加一级引用符号即可在提示框中嵌入另一个提示框。
|
|
|
|
> [!FAILURE] 未达到预期
|
|
> 示例：资料中缺少日期，需要补充后再归档。
|
|
|
|
> [!DANGER] 风险提示
|
|
> 示例：不要把唯一一份原始资料直接覆盖为整理结果。
|
|
|
|
> [!BUG] 问题记录
|
|
> 示例：发现显示异常时，记录主题、操作步骤和对应 Markdown 源码。
|
|
|
|
> [!EXAMPLE] 示例
|
|
> 将提示内容写成一句明确的说明，比只写“注意”更容易理解。
|
|
|
|
> [!QUOTE] 摘录
|
|
> 一条笔记既要保留结论，也要保留形成结论的依据。
|
|
|
|
## 默认展开与默认折叠
|
|
|
|
> [!TIP]+ 默认展开：点击标题试试
|
|
> 类型后的 `+` 表示默认展开。点击标题可收起，再次点击可展开。
|
|
|
|
> [!WARNING]- 默认折叠：点击查看内容
|
|
> 你已经展开了这段说明。类型后的 `-` 表示重新渲染时默认收起。
|
|
>
|
|
> 正文可以包含 **加粗**、*斜体*、~~删除线~~ 和 `行内代码`。
|
|
|
|
## 嵌套与混合格式
|
|
|
|
> [!INFO]+ 一次资料整理
|
|
> 先整理来源，再检查缺漏。
|
|
>
|
|
> 1. 收集原始资料。
|
|
> 2. 按主题分组。
|
|
> 3. 为尚未确认的内容添加说明。
|
|
>
|
|
> > [!SUCCESS] 已收集
|
|
> > 原始笔记、会议纪要和参考链接已放入同一文件夹。
|
|
>
|
|
> > [!WARNING]- 尚待确认
|
|
> > 一条资料缺少发布日期，需要补充来源。
|
|
>
|
|
> | 项目 | 状态 |
|
|
> | --- | --- |
|
|
> | 原始资料 | 已归档 |
|
|
> | 日期核对 | 待补充 |
|
|
>
|
|
> ```python
|
|
> notes = ["原始资料", "整理结果"]
|
|
> print(len(notes))
|
|
> ```
|
|
>
|
|
> 行内公式：$a^2 + b^2 = c^2$。
|
|
|
|
## 类型别名
|
|
|
|
别名不区分大小写。下面的表格列出兼容关系。
|
|
|
|
| 类型 | 别名 |
|
|
| --- | --- |
|
|
| abstract | summary、tldr |
|
|
| tip | hint |
|
|
| success | check、done |
|
|
| question | help、faq |
|
|
| warning | caution、attention |
|
|
| failure | fail、missing |
|
|
| danger | error |
|
|
| quote | cite |
|
|
|
|
> [!summary] 摘要别名
|
|
> 这段使用 `summary`，外观与 `abstract` 一致。
|
|
|
|
> [!check] 成功别名
|
|
> 这段使用 `check`，外观与 `success` 一致。
|
|
|
|
> [!custom-demo] 未知类型的回退
|
|
> 自定义类型暂时使用 note 外观，源文件中的类型名仍然保留。
|
|
|
|
## 语法对照
|
|
|
|
以下围栏中的内容应当保持为代码，不渲染成警告框。
|
|
|
|
```markdown
|
|
> [!NOTE] 自定义标题
|
|
> 正文内容。
|
|
|
|
> [!WARNING]- 默认折叠
|
|
> 点击标题查看正文。
|
|
|
|
> [!TIP]+ 默认展开
|
|
> 默认可见的正文。
|
|
```
|
|
|
|
普通行内代码也保持原样：`[!WARNING]`。
|
|
|
|
> 这是一段普通引用，没有提示类型标记，因此不应显示为警告框。
|
|
|
|
## 主题与保存体验清单
|
|
|
|
- [ ] 在浅色、深色、护眼主题下区分信息、成功、警告与危险颜色。
|
|
- [ ] 使用纸间时光，查看纸张虚线边框和嵌套层次。
|
|
- [ ] 使用 Ocean Blue 与 Midnight Purple，检查标题和正文是否清晰。
|
|
- [ ] 点击折叠标题，并使用 Tab、Enter 或空格体验键盘操作。
|
|
- [ ] 在源码模式修改一个类型或标题，再切回写作模式。
|
|
- [ ] 保存并重新打开，确认类型、标题、正文与默认折叠状态保持一致。
|
|
|
|
这是一份手动体验清单，未勾选不表示功能失败。桌面容器的原生格式快捷键与元数据转换仍属于第三阶段规划。
|