Avatar: Pelican的插件

此插件允许包含与文章作者电子邮件地址相对应的Libravatar或Gravatar用户个人资料图片。

安装

此插件可以通过以下方式安装

python -m pip install pelican-avatar

只要您没有在Pelican设置文件中明确添加PLUGINS设置，则新安装的插件应自动检测并启用。否则，您必须将avatar添加到现有的PLUGINS列表中。有关更多信息，请参阅如何使用插件文档。

使用方法

指定作者的电子邮件地址

默认电子邮件地址来自Pelican设置文件中的AVATAR_AUTHOR_EMAIL变量。此默认值可以在每篇文章的基础上通过在文章元数据中指定电子邮件地址来覆盖。

对于reStructuredText

:email: bart.simpson@example.com

对于Markdown

Email: bart.simpson@example.com

插件首先尝试在Libravatar中找到与指定电子邮件相对应的头像图片。如果没有找到，插件随后在Gravatar中搜索。如果在任何这些服务中都没有找到指定的电子邮件地址的头像，则显示默认图片。默认的“缺失图片”可以在配置变量AVATAR_MISSING中定义。

调整模板

此插件将author_avatar变量分配给头像图片URL，并在文章的上下文中使该变量可用。例如，您可以将以下内容添加到模板文件中（例如，到article_infos.html模板文件），在作者信息之前

{% if article.author_avatar %}
<div align="center">
        <img src="{{ article.author_avatar }}">
</div>
{% endif %}

这将产生以下结果（使用notmyidea主题）

页面模板以类似的方式工作

{% if page.author_avatar %}
<div align="center">
        <img src="{{ page.author_avatar }}">
</div>
{% endif %}

要在通用模板中使用，例如base.html，您可以这样做

{% if author_avatar %}
<div align="center">
        <img src="{{ author_avatar }}">
</div>
{% endif %}

或者如果您想支持在文章或页面中可选地覆盖电子邮件地址，同时仍然使用全局配置，如果两者都不可用

{% if article and article.author_avatar %}
  {% set author_avatar = article.author_avatar %}
{% elif page and page.author_avatar %}
  {% set author_avatar = page.author_avatar %}
{% endif %}
{% if author_avatar %}
<div align="center">
        <img src="{{ author_avatar }}">
</div>
{% endif %}

配置

以下变量可以在Pelican设置文件中设置

• AVATAR_AUTHOR_EMAIL：网站默认作者电子邮件地址。

• AVATAR_MISSING：缺失图片的默认值。这可以是URL（例如，"http://example.com/nobody.png"）或徽标库的名称（例如，"wavatar"；有关所有替代方案，请参阅Libravatar API）。

• AVATAR_SIZE：个人图片的大小，以像素为单位（它始终是正方形，所以高度等于宽度）。如果没有指定，Libravatar将返回默认大小（80×80）。

• AVATAR_USE_GRAVATAR：默认情况下，插件通过Libravatar服务查找头像。可以通过将此配置变量设置为True来强制搜索Gravatar服务。

致谢

此插件的灵感来自Gravatar插件。

贡献

欢迎并非常感谢贡献。每一份贡献都很有帮助。您可以通过改进文档、添加缺失功能以及修复错误来做出贡献。您还可以通过审查和评论现有问题来提供帮助。

要开始为此插件做出贡献，请审查为Pelican做出贡献文档，从贡献代码部分开始。

鸣谢

感谢Justin Mayer在Pelican插件组织下帮助迁移此插件，感谢Troy Curtis添加了对页面生成器和全局生成器上下文的支持，并改进了Poetry工作流程，感谢Lucas Cimon在测试套件和CI支持中的修复，以及感谢Christian Clauss进行Python 3移植。

作者

版权（C）2015，2021-2024 Rafael Laboissière（rafael@laboissiere.net）

许可证

本项目遵循AGPL 3.0许可协议。