提示hint
和插图编号callout
hint
== callout
== 提示/警告/错误等特殊格式
演示用插件callout
(具体是honkit-plugin-blockquote-callout)实现的callout
==hint
==alert
,即各种类型的提示/提醒的效果
语法:
> [!{type}]
> your text
其中{type}
是下面中的任意一种:
NOTE
TIP
IMPORTANT
WARNING
CAUTION
UnsupportedAnnotation
效果如下的显示:
注解=NOTE
Note
注解类信息中的内容
提示=TIP
Tip
提示类信息中的内容
重要=IMPORTANT
Important
重要类信息中的内容
警告=WARNING
Warning
警告类信息中的内容
告诫=CAUTION
=error=错误
Caution
告诫类信息中的内容
其他的、普通的block内容=UnsupportedAnnotation
[!UnsupportedAnnotation]
没有此处特殊格式的、普通的、block块的内容
注意,每行内容之间,要保留一行多余的
>
,才是普通的block内容的格式
支持参数自定义
举例
[!Warning|title:※注]
- 把
Warning
的title标题的文字,换成:※注
- 把
代码:
> [!Warning|title:※注]
> 把标题"Warning"换成:`※注`
效果:
※注
把标题"Warning"换成:※注
相关
注意到另外一个(旧的gitbook的)插件:
其语法格式和此处很类似
且看到有额外的参数设置:
Key=关键字 | Allowed value=允许的值 |
---|---|
style | One of follwowing values: callout , flat |
label | Any text |
icon | A valid Font Awesome icon, e.g. fa fa-info-circle |
className | A name of a CSS class which specifies the look and feel |
labelVisibility | One of follwowing values: visible (default), hidden |
iconVisibility | One of follwowing values: visible (default), hidden |
但是经过实际测试,此处并不支持这些参数。
记录于此,仅供参考。