在标记中轻松显示图标字体。
markdown-iconfonts的Python项目详细描述
标记图标(iconfonts.py
)
在python标记中轻松显示图标字体。只需添加字体所需的css并添加此扩展名。
这是Python Markdown的第三方扩展。你可以看到一个full list of 3rd party extensions here。
尽管这适用于任何图标字体,但用户可以使用mod
语法添加更多前缀类以支持Font Awesome及其特殊类,如2x, 3x, muted, spin, etc
此外,用户可以添加自己的user_mod
语法来添加额外的、无前缀的、预定义的类,以便更好地控制图标,同时允许您精确地控制允许的样式。
- 您可以使用icomoon应用程序创建自己的图标字体:http://icomoon.io/app/
- 一个很好的预先制作的图标字体是Font Awesome (GitHub Project)
有关详细信息,请参见python markdown documentation。
在任何你想要的个人或商业项目中使用它。
语法:
- 接受a-z、a-z、0-9、(下划线)和-(hypen)
- 使用类似于HTML Entity的语法:
&entity_name;
&icon-html5;
&icon-css3;
&icon-my-icon;
mod语法:
&icon-html5:2x;
&icon-quote:3x,muted;
&icon-spinner:large,spin;
用户模式语法:
&icon-html5::red;
&icon-quote:2x:bold;
标记示例:
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-”:
importmarkdownmd=markdown.Markdown(extensions=['iconfonts'])
或
importmarkdownfromiconfontsimportIconFontsExtensionmd=markdown.Markdown(extensions=[IconFontsExtension()])
选项允许使用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
- 安装标记图标。将
iconfonts.py
文件复制到site-packages/markdown/extensions/
- 导航到cmd/terminal中的测试目录并运行
python unit-tests.py -v