警告预处理器

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 typetranslates to
errorwarning
dangerwarning
cautionwarning
infonotice
notenotice
tipnotice
hintnotice

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java在带有ActionListener和ifelse语句Jbutton的JFrame上使用JTextFields、JButtons和JLabels不起作用   java如何从另一个应用程序打开我们的活动页面?   UUID生成的字符的java类型   jar包含IsoOutputStream和IsoBufferWrapperImpl类的java   JAVA创建自定义。ECLIPSE中的几个现有类库文件   Java包结构约定   java空指针异常,仅当我尝试数组形式的类型时   来自过滤器的java转发请求   java是在pom中生成Maven依赖项的简单方法。xml?   java请求   在HashMap中使用字符串数组,Java   显示用户在谷歌地图中预定义位置方向的java   在Java中重新测试特定的方法   如何将html表单中的输入转换为Java字符串变量?   java有人知道Maven2 POM类路径容器的Eclipse(WSAD/RAD)插件吗   json从java列表中抓取数据   SpringJava。lang.ClassCastException:org。阿帕奇。德比。客户是ClientPreparedStatement42不能强制转换为组织。阿帕奇。德比。iapi。sql。准备好的报表