Pelican plugin to add custom emoji to your site
Project description
Pelimoji
Pelimoji is a Pelican plugin that adds support for custom emoji to your site.
Installation
This plugin can be installed via:
python -m pip install pelimoji
As long as you have not explicitly added a PLUGINS
setting to your Pelican settings file, then the newly-installed plugin should be automatically detected and enabled. Otherwise, you must add pelimoji
to your existing PLUGINS
list. For more information, please see the How to Use Plugins documentation.
Usage
Within your PATH
content root create a directory called emoji
. To that directory, add any square image files at least 16x16 ending in .png
. These will be your emoji, addressable via the filename before the extension, such as :gentoo:
if you had a file named gentoo.png
in your PELIMOJI_PATH
. This is case-sensitive if your filesystem is case-sensitive. 64x64 works best, but any size will do, including 512x512. Just remember, this will affect load speed for your pages.
When compiling your site, the following directory will be created and automatically added to your STATIC_PATHS
: PATH/emoji_map/
. You'll need to ensure that PATH/emoji_map/emoji.css
is loaded as a stylesheet, whether using something like webassets
or cssmin
, or by adding directly.
You may optionally also specify a PELIMOJI_PREFIX
to require if you might have multiple sets of colon-tags that'd overlap. Whereas I might normally use :thumbs-up:
, I could then specify PELIMOJI_PREFIX = "emoji"
, and my tag would instead be :emoji-thumbs-up:
.
By default this plugin operates on source content files with the following file extensions: ["md", "html", "rst"]
, corresponding to Markdown, HTML, and reStructuredText. If you, say, want this plugin to also process files ending in .txt
, you should add the following to your settings file:
PELIMOJI_FILE_EXTENSIONS = ["md", "html", "rst", "txt"]
Contributing
Contributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on existing issues.
To start contributing to this plugin, review the Contributing to Pelican documentation, beginning with the Contributing Code section.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pelimoji-1.1.1.tar.gz
.
File metadata
- Download URL: pelimoji-1.1.1.tar.gz
- Upload date:
- Size: 5.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73934536ed6552a3ccfc87d87e0c649e9f2d600d6f69f9366be82dddf0f6a9b9 |
|
MD5 | 7309ff3198629a8997d8f89e8f1cf938 |
|
BLAKE2b-256 | e45d6d2f9a752a9752a67313d03362bdf6ef125c7b957b7c6b292f6fe5acb99b |
File details
Details for the file pelimoji-1.1.1-py3-none-any.whl
.
File metadata
- Download URL: pelimoji-1.1.1-py3-none-any.whl
- Upload date:
- Size: 5.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | be761562c80bb10da1418a6756a6dfb2b523972f4ceb5077732316096686eeb6 |
|
MD5 | 08bd83e68df476d2be211ec02f333b03 |
|
BLAKE2b-256 | 0211196d78b6f3846cc188a03c88646b27e278f7dbaef2abb7333a02271408f6 |