跳转到主要内容

Pelican插件,用于向您的网站添加自定义表情符号

项目描述

Pelimoji

Build Status PyPI Version License

Pelimoji是一个Pelican插件,它为您的网站添加了对自定义表情符号的支持。

安装

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

python -m pip install pelimoji

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

用法

在您的 PATH 内容根目录下创建一个名为 emoji 的目录。向该目录添加任何至少为 16x16 的正方形图像文件,并以 .png 结尾。这些就是您的表情符号,可以通过扩展名前的文件名访问,例如,如果您在 PELIMOJI_PATH 中有一个名为 gentoo.png 的文件,则可以使用 :gentoo:。如果您的文件系统区分大小写,则此操作区分大小写。64x64 最好,但任何大小都可以,包括 512x512。只需记住,这会影响您页面的加载速度。

在编译您的站点时,将创建以下目录并自动添加到您的 STATIC_PATHS 中:PATH/emoji_map/。您需要确保 PATH/emoji_map/emoji.css 作为样式表加载,无论是使用 webassetscssmin 还是直接添加。

您还可以可选地指定一个 PELIMOJI_PREFIX,如果您可能有多个可能重叠的冒号标记集。例如,我可能通常使用 :thumbs-up:,但我可以指定 PELIMOJI_PREFIX = "emoji",然后我的标签将改为 :emoji-thumbs-up:

默认情况下,此插件对具有以下文件扩展名的源内容文件进行操作:["md", "html", "rst"],对应于 Markdown、HTML 和 reStructuredText。如果您想使此插件也处理以 .txt 结尾的文件,您应在设置文件中添加以下内容:

PELIMOJI_FILE_EXTENSIONS = ["md", "html", "rst", "txt"]

贡献

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

要开始为该插件做出贡献,请审阅 Pelican 贡献 文档,从 贡献代码 部分开始。

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关 安装软件包 的更多信息。

源分布

pelimoji-1.1.1.tar.gz (5.0 kB 查看哈希值)

上传时间

构建分布

pelimoji-1.1.1-py3-none-any.whl (5.1 kB 查看哈希值)

上传时间 Python 3

由以下赞助

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面