600 字
3 分钟
Markdown 提示容器(Admonitions)

提示容器让补充信息在视觉上与正文区分开,同时不破坏阅读流。所有形式都在服务端渲染,共用同一套紧凑的 M3E 组件。

各类型写法与效果#

支持 note、info、tip、important、warning、caution,以及可折叠的 details。

note(带自定义标题)#

写法

::: note 部署背景
空格形式接受普通的自定义标题,同时与参考语法保持兼容。
:::

渲染效果

info#

写法

:::info
信息块用于提供中性背景,帮助读者理解上下文。
:::

渲染效果

tip(方括号标题 + 行内 Markdown)#

写法

:::tip[已有的 **标签** 语法]
原始的方括号标签依然可用,且能包含行内 Markdown 强调。
:::

渲染效果

important(GitHub Alert 语法)#

写法

> [!IMPORTANT]
> GitHub Alert 语法进入同一个渲染器,因此既有文章保持统一的视觉语言。

渲染效果

warning#

写法

:::warning
运行生产构建前请检查环境变量。
:::

渲染效果

caution#

写法

:::caution
不要在示例中发布凭据、本地配置或私钥。
:::

渲染效果

可折叠的 details#

details 类型渲染为可折叠块,初始收起,适合放可选的长命令、排错步骤。

写法

::: details 查看完整命令
该折叠块使用浏览器原生语义,无需客户端 JavaScript 也可键盘访问。
```powershell
npx.cmd astro check
pnpm.cmd build
```
- 初始为收起状态。
- 长代码可在自己的代码块内滚动。
- 窄屏下容器仍保持在文章宽度内。
:::

渲染效果

查看完整命令

该折叠块使用浏览器原生语义,无需客户端 JavaScript 也可键盘访问。

Terminal window
npx.cmd astro check
pnpm.cmd build
  • 初始为收起状态。
  • 长代码可在自己的代码块内滚动。
  • 窄屏下容器仍保持在文章宽度内。

标题的两种写法#

:::note[方括号标题]
内容
:::
::: warning 空格标题(Plume 兼容)
内容
:::

第 3 篇,共 20 篇本文属于系列

分享文章

生成精美分享图或复制链接,与更多人分享本文。

继续阅读

沿着主题读

基于共同的标签与分类

换条路线

从其他文章中稳定抽取