Pelican插件,用于设置锚标签的class属性,以区分内部和外部链接
项目描述
Link Class:Pelican插件
此Pelican插件允许您根据链接是外部链接(即以http://或https://开头)还是内部链接(即在Pelican生成的站点内部)来设置<元素的class属性。
目前,此插件仅支持Markdown。它已经与Python-Markdown模块的3.0+版本进行了测试,可能不支持旧版本。
安装
此插件作为PyPI上的一个包提供,可以通过以下方式安装:
python -m pip install pelican-linkclass
配置
为了避免与用户CSS样式表中的已定义类冲突,可以指定将使用的类名。可以在Pelican设置文件中使用LINKCLASS
变量指定,该变量必须定义为元组列表,如下所示:
'LINKCLASS' = (('EXTERNAL_CLASS', 'name-of-the-class-for-external-links'),
('INTERNAL_CLASS', 'name-of-the-class-for-internal-links'))
EXTERNAL_CLASS
和INTERNAL_CLASS
的默认值分别为'external'
和'internal'
。
超链接样式
此插件的一个可能用途是用于样式设计。假设您的文章中有以下Markdown内容:
This is an [internal](internal) link and this is an
[external](http://external.com) link.
如果使用默认配置变量值,则可能的CSS设置可能是:
a.external:before {
content: url('../images/external-link.png');
margin-right: 0.2em;
}
(该插件还附带external-link.png
文件。要使用它,将其复制到您的网站源代码树中的适当位置,例如在theme/static/images/
。)
然后,结果将如下所示:
请注意,此插件还支持参考样式链接,如下例所示:
This is an [internal][internal] link and this is an
[external][external] link.
[internal]: internal
[external]: http://external.com
贡献
欢迎并非常感谢贡献。每一份努力都很重要。您可以通过改进文档、添加缺少的功能和修复错误来做出贡献。您还可以通过审查和评论现有问题来帮忙。
要开始为此插件做出贡献,请查看为Pelican做出贡献文档,从为代码做出贡献部分开始。
致谢
感谢Yuliya Bagriy为PyPI设置包,感谢Lucas Cimon修复了与pytest相关的问题,感谢Justin Mayer在Pelican插件组织下帮助迁移此插件。
作者
版权所有 © 2015, 2017, 2019, 2021-2023 Rafael Laboissière (rafael@laboissiere.net)
许可证
本项目根据GNU Affero公共许可证第3版或更高版本的条款发布。