树叶的徽章。
foliantcontrib.badges的Python项目详细描述
徽章
有助于在您的文档中添加徽章的叶子预处理器。它使用Shields.io生成徽章。
安装
$ pip install foliantcontrib.badges
配置
要启用预处理器，请将badges添加到项目配置中的preprocessors部分：
preprocessors:-badges
预处理器有许多选项：
preprocessors:-badges:server:'https://img.shields.io'as_object:trueadd_link:truevars:jira_path:localhost:3000/jirapackage:foliant# badge look parametersstyle:flat-squarelogo:jira
server
：shields服务器url，其中托管徽章。默认值：https://img.shields.io
as_object
：如果true-预处理器插入带有html <object>标记的svg徽章，而不是标记图像标记。这是链接和提示工作所必需的。默认值：true
add_link
：如果true预处理器试图确定应添加到标记的链接（例如，链接到jira issue badge的jira issue页面）。仅适用于as_object = true。默认值：true
Please note that right now only links for pypi and jira-issue badges are being added automatically. Please contribute or contact author for adding other services.
vars
：包含将在徽章URL中替换的变量的字典。请参阅变量部分。
您还可以添加shields.io网站上指定的参数，这些参数会改变徽章视图，例如：label、logo、style等。
用法
只需添加badge标记并在标记体中指定标记的路径：
<badge>jira/issue/https/issues.apache.org/jira/kafka-2896.svg</badge>
配置中的所有选项都可以在标记参数中覆盖：
<badge style="social" as_object="false">jira/issue/https/issues.apache.org/jira/kafka-2896.svg</badge>
变量
您可以在徽章中使用变量来替换经常重复的部件。例如，如果我们需要向jira跟踪器添加许多徽章，我们可以将协议和主机参数放入如下变量：
preprocessors:-badges:vars:jira:https/issues.apache.org/jira
要引用徽章路径中的变量，请使用语法${variable}：
<badge>jira/issue/${jira}/kafka-2896.svg</badge>
Description of the issue goes here. But it's not the only one.
<badge>jira/issue/${jira}/KAFKA-7951.svg</badge>
Description of the second issue.
欢迎加入QQ群-->： 979659372
