~fkfd/mkdocs-emote-plugin

Adds emote (custom emoji) support to MkDocs
Make emotes that take an entire paragraph a sticker
Fix README again I am very stupid

refs

main
browse  log 

clone

read-only
https://git.sr.ht/~fkfd/mkdocs-emote-plugin
read/write
git@git.sr.ht:~fkfd/mkdocs-emote-plugin

You can also use your local clone with git send-email.

#MkDocs Emote Plugin

Adds "emote" (custom emoji) support to MkDocs.

#How To Use

In your source folder (e.g. docs/), create a directory (e.g. docs/emote/). The name of this directory is configurable with option emote_dir in mkdocs.yml.

Example:

plugins:
  - emote:
      emote_dir: emote

All image files (with file extension png, apng, webp, gif, and jpg) in the emote directory and all subdirectories will be considered "emotes".

To use an emote when writing Markdown, just write :emote_name:. This plugin will replace it with an HTML <img> tag pointing to the emote file with the same name, case-insensitive. For example, if the file docs/emote/floof/floofWoozy.png exists, then all occurrences of :floofWoozy:, :floofwoozy:, :fLoOfWoOzY:, etc. will be replaced.

The <img> tag has class="emote", allowing for custom CSS. The recommended styling is

img.emote {
    display: inline;
    height: 1.5em;
    width: 1.5em;
}

If no file named floofwoozy (case-insensitive) exists, then the string is kept as-is.

Do not follow this link