在文章中嵌入各种提示横幅

目录

在文章中嵌入包括引用、示例、注意、摘要、提醒、状态等提示性条幅显示效果。

以下有 12 种 帮助你在页面中插入提示的横幅.

支持 Markdown 或者 HTML 格式.

注意
这里是关于 注意 的说明文字
1
2
3
{{< admonition note "注意" open >}}
这里是关于 **注意** 的说明文字
{{< /admonition >}}
摘要
这里是关于 摘要 的说明文字
1
2
3
{{< admonition abstract "摘要" open >}}
这里是关于 **摘要** 的说明文字
{{< /admonition >}}
信息
这里是关于 信息 的说明文字
1
2
3
{{< admonition info "信息" open >}}
这里是关于 **信息** 的说明文字
{{< /admonition >}}
技巧
这里是关于 技巧 的说明文字
1
2
3
{{< admonition tip "技巧" open >}}
这里是关于 **技巧** 的说明文字
{{< /admonition >}}
成功
这里是关于 成功 的说明文字
1
2
3
{{< admonition success "成功" open >}}
这里是关于 **成功** 的说明文字
{{< /admonition >}}
问题
这里是关于 问题 的说明文字
1
2
3
{{< admonition question "问题" open >}}
这里是关于 **问题** 的说明文字
{{< /admonition >}}
警告
这里是关于 警告 的说明文字
1
2
3
{{< admonition warning "警告" open >}}
这里是关于 **警告** 的说明文字
{{< /admonition >}}
失败
这里是关于 失败 的说明文字
1
2
3
{{< admonition failure "失败" open >}}
这里是关于 **失败** 的说明文字
{{< /admonition >}}
危险
这里是关于 危险 的说明文字
1
2
3
{{< admonition danger "危险" open >}}
这里是关于 **危险** 的说明文字
{{< /admonition >}}
Bug
这里是关于 Bug 的说明文字
1
2
3
{{< admonition example "Bug" open >}}
这里是关于 **Bug** 的说明文字
{{< /admonition >}}
示例
这里是关于 示例 的说明文字
1
2
3
{{< admonition example "示例" open >}}
这里是关于 **示例** 的说明文字
{{< /admonition >}}
引用
这里是关于 引用 的说明文字
1
2
3
{{< admonition quote "引用" open >}}
这里是关于 **引用** 的说明文字
{{< /admonition >}}

1
2
3
4
5
6
7
{{< admonition type=tip title="This is a tip" open=false >}}
一个 **技巧** 横幅
{{< /admonition >}}
或者
{{< admonition tip "This is a tip" false >}}
一个 **技巧** 横幅
{{< /admonition >}}

呈现的输出效果如下:

This is a tip
一个 技巧 横幅

命名参数说明:

  • type [必需] (第一个位置参数)

    横幅的类型, 默认值是 note.

  • title [可选] (第二个位置参数)

    横幅的标题, 默认值是 type 参数的值.

  • open [可选] (第三个位置参数)

    横幅内容是否默认展开, 默认值是 true.