警告预处理器
foliantcontrib.admonitions的Python项目详细描述
https://img.shields.io/pypi/v/foliantcontrib.admonitions.svg
叶面警告预处理器
预处理器,试图使警告语法可用于大多数后端。
警告是经过修饰的文本片段,表示警告、通知、提示等。
我们使用的rST-style syntax for admonitions已经由mkdocs后端支持,并且打开了admonition
扩展。此预处理器使此语法适用于pandoc和slate后端。
安装
$ pip install foliantcontrib.admonitions
配置
只需将admonitions
添加到预处理器列表中。现在预处理器没有任何选项:
preprocessors:-admonitions
用法
在标记文件中添加警告:
!!! warning "optional admonition title"
Admonition text.
May be several paragraphs.
板岩笔记
slate有自己的三种警告语法:notice
(蓝色注释)、warning
(红色警告)和success
(绿色注释)。如果提供了另一种类型,slate会绘制一个蓝色的音符,但没有“i”图标。
为了方便起见,警告预处理器将一些常规警告类型转换为slate类型(因此您可以使用error
类型在slate和mkdoc中显示相同的注释)。下表显示了这些翻译:
original type | translates to |
---|---|
error | warning |
danger | warning |
caution | warning |
info | notice |
note | notice |
tip | notice |
hint | notice |