markdown-icons (iconfonts.py)

在python markdown中轻松显示图标字体。只需添加字体所需的CSS并添加此扩展。

这是Python Markdown的第三方扩展。您可以在Python Markdown中看到第三方扩展的完整列表。

虽然它与任何图标字体都兼容，但用户可以使用mod语法添加更多前缀类来支持Font Awesome及其特殊类，如2x, 3x, muted, spin, 等

此外，用户可以添加自己的user_mod语法来添加更多非前缀、预定义的类，以更好地控制图标，同时允许您精确控制允许的样式。

• 您可以使用IcoMoon应用创建自己的图标字体：[http://icomoon.io/app/](http://icomoon.io/app/)
• 一个优秀的预制作图标字体是Font Awesome (GitHub项目)

有关更多信息，请参阅python markdown文档。

您可以在任何个人或商业项目中使用它。

语法

• 接受a-z，A-Z，0-9，_(下划线)和-(连字符)
• 使用HTML实体语法：&entity_name;

&icon-html5;
&icon-css3;
&icon-my-icon;

Mod语法

&icon-html5:2x;
&icon-quote:3x,muted;
&icon-spinner:large,spin;

User mod语法

&icon-html5::red;
&icon-quote:2x:bold;

示例Markdown

I love &icon-html5; and &icon-css3;
&icon-spinner:large,spin; Sorry we have to load...

输出

I love <i aria-hidden="true" class="icon-html5"></i> and <i aria-hidden="true" class="icon-css3"></i>
<i aria-hidden="true" class="icon-spinner icon-large icon-spin"></i> Sorry we have to load...

安装

pip install markdown-iconfonts

使用/设置

默认前缀为"icon-"

import markdown

md = markdown.Markdown(extensions=['iconfonts'])

或

import markdown
from iconfonts import IconFontsExtension

md = markdown.Markdown(extensions=[IconFontsExtension()])

base选项允许使用Bootstrap 3和FontAwesome 4图标

md = markdown.Markdown(extensions=['iconfonts'],
                       extension_configs={"base":"icon"})
converted_text = md.convert(text)

输入: &icon-html5;

输出: <i aria-hidden="true" class="icon icon-html5"></i>

prefix_base_pairs 选项

prefix_base_pairs 选项允许指定多个前缀-基础对，以便您支持 Bootstrap 3/Glyphicon 和 FontAwesome 图标

md = markdown.Markdown(extensions=['iconfonts'],
                       extension_configs={
                           'iconfonts': {
                               'prefix_base_pairs': {
                                   'fa-': 'fa',
                                   'glyphicon-': 'glyphicon',
                               }
                           }
                       })
converted_text = md.convert(text)

输入: &glyphicon-remove; &fa-html5;

输出: <i aria-hidden="true" class="glyphicon glyphicon-remove"></i><i aria-hidden="true" class="fa fa-html5"></i>

如何运行单元测试

• 安装 Markdown: pip install markdown
• 安装 markdown icons。将 iconfonts.py 文件复制到 site-packages/markdown/extensions/
• 在 CMD/终端中导航到测试目录并运行 python unit-tests.py -v