For AI agents: the complete documentation index is available at https://lazygophers.github.io/pamphlet/llms.txt, the full documentation bundle is available at https://lazygophers.github.io/pamphlet/llms-full.txt, and this page is available as Markdown at https://lazygophers.github.io/pamphlet/write/components/callout.md.
  • 简体中文
  • 提示块

    这是什么

    从正文里跳出来的一小块话:补充说明、小技巧、警告、危险。四种,各自一个指令名。

    怎么写

    :::info[这是提示]
    写背景、写补充说明。
    :::
    
    :::tip[这是建议]
    写「这样做更好」。
    :::
    
    :::warn[小心]
    写「不注意会踩到」。
    :::
    
    :::danger[别这么干]
    写「踩到了会出事」。
    :::

    方括号里那行是指令标题,可以不写:

    :::info
    没有标题的提示块。
    :::

    四种都不接受任何属性({} 里的东西)。

    怎么选

    用哪个什么时候
    info补充说明,不看也不影响
    tip有更省事的做法
    warn不注意会出问题
    danger一定出问题,或者不可逆

    出来是什么样

    左边一条 3px 竖线,颜色按类型走 --pf-info / --pf-tip / --pf-warn / --pf-danger;底色四种统一用 --pf-bg-subtle。

    不渲染图标

    四种的区别只在左边那条线的颜色,没有图标。想加图标目前没有办法。

    个别主题会改形态:paper 把它变成页边的旁注,lesson 把 tip 做成一个描边的重点框。

    坑

    • 没有 callout 这个指令。它是这四种的统称,写 :::callout 会报 DIR-201 警告,提示里会列出四个真名
    • 一页别放五个。四种的区别只在一条线的颜色,满屏提示块等于没有提示块;一屏里最多一个 danger
    • 四种在无 JavaScript 时表现完全一样——它们本来就是纯 CSS,不带任何交互