Fixit-Admonition

geekswg 收录于 mydocs

2023-02-03 2023-06-26 约 900 字预计阅读 2 分钟 - 次阅读 - 条评论

警告

本文最后更新于 2023-06-26，文中内容可能已过时。

admonition shortcode 支持 12 种帮助你在页面中插入提示的横幅.
支持 Markdown 或者 HTML 格式.

1 参数说明

admonition shortcode 有以下命名参数:

type [可选] (第一个位置参数)
admonition 横幅的类型, 默认值是 note.
title [可选] (第二个位置参数)
admonition 横幅的标题, 默认值是 type 参数的值.
open [可选] (第三个位置参数)
横幅内容是否默认展开, 默认值是 true.

一个 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

一个技巧横幅

2 所有示例

2.1 注意

注意

一个注意横幅

1
2
3
{{< admonition >}}
一个 **注意** 横幅
{{< /admonition >}}

2.2 摘要

摘要

一个摘要横幅

1
2
3
{{< admonition abstract >}}
一个 **摘要** 横幅
{{< /admonition >}}

2.3 信息

信息

一个信息横幅

1
2
3
{{< admonition info >}}
一个 **信息** 横幅
{{< /admonition >}}

2.4 技巧

技巧

一个技巧横幅

1
2
3
{{< admonition tip >}}
一个 **技巧** 横幅
{{< /admonition >}}

2.5 成功

成功

一个成功横幅

1
2
3
{{< admonition success >}}
一个 **成功** 横幅
{{< /admonition >}}

2.6 问题

问题

一个问题横幅

1
2
3
{{< admonition question >}}
一个 **问题** 横幅
{{< /admonition >}}

2.7 警告

警告

一个警告横幅

1
2
3
{{< admonition warning >}}
一个 **警告** 横幅
{{< /admonition >}}

2.8 失败

失败

一个失败横幅

1
2
3
{{< admonition failure >}}
一个 **失败** 横幅
{{< /admonition >}}

2.9 危险

危险

一个危险横幅

1
2
3
{{< admonition danger >}}
一个 **危险** 横幅
{{< /admonition >}}

2.10 Bug

Bug

一个 Bug 横幅

1
2
3
{{< admonition bug >}}
一个 **Bug** 横幅
{{< /admonition >}}

2.11 示例

示例

一个示例横幅

1
2
3
{{< admonition example >}}
一个 **示例** 横幅
{{< /admonition >}}

2.12 引用

引用

一个引用横幅

1
2
3
{{< admonition quote >}}
一个 **引用** 横幅
{{< /admonition >}}

3 总结如下

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{{< admonition >}}
一个 **注意** 横幅
{{< /admonition >}}

{{< admonition abstract >}}
一个 **摘要** 横幅
{{< /admonition >}}

{{< admonition info >}}
一个 **信息** 横幅
{{< /admonition >}}

{{< admonition tip >}}
一个 **技巧** 横幅
{{< /admonition >}}

{{< admonition success >}}
一个 **成功** 横幅
{{< /admonition >}}

{{< admonition question >}}
一个 **问题** 横幅
{{< /admonition >}}

{{< admonition warning >}}
一个 **警告** 横幅
{{< /admonition >}}

{{< admonition failure >}}
一个 **失败** 横幅
{{< /admonition >}}

{{< admonition danger >}}
一个 **危险** 横幅
{{< /admonition >}}

{{< admonition bug >}}
一个 **Bug** 横幅
{{< /admonition >}}

{{< admonition example >}}
一个 **示例** 横幅
{{< /admonition >}}

{{< admonition quote >}}
一个 **引用** 横幅
{{< /admonition >}}

Fixit-Admonition

1 参数说明

2 所有示例

2.1 注意

2.2 摘要

2.3 信息

2.4 技巧

2.5 成功

2.6 问题

2.7 警告

2.8 失败

2.9 危险

2.10 Bug

2.11 示例

2.12 引用

3 总结如下

相关内容