8 releases
0.3.0 | Sep 20, 2023 |
---|---|
0.2.2 | Mar 22, 2023 |
0.2.1 | Feb 24, 2023 |
0.1.3 | Feb 3, 2023 |
0.1.2 | Jan 3, 2023 |
#1403 in Parser implementations
128 downloads per month
13KB
236 lines
mdbook-emojicodes
mdbook-emojicodes
is a MDBook preprocessor to replace your emojicodes (e.g. :cat:
) to emojis. No more copy-pasting!
📦 Installation
Using crates.io
$ cargo install mdbook-emojicodes
Manual installation
Clone the repo
$ git clone https://github.com/blyxyas/mdbook-emojicodes
Build & Install the preprocessor
$ cd mdbook-emojicodes;
cargo install --path .
❓ Usage
Write this in your book.toml
:
[preprocessor.emojicodes]
Now, ✨ It's ready to use! ✨.
You can use emojis by writing an emojicode in your files.
Example
<!-- my_chapter.md -->
# My :cat: cat journey
I love cats :cat: and dogs :dog:, I have two, one's gray, like a raccoon :raccoon:, and the other one is black, like the night :night_with_stars:.
This will render to:
<!-- my_chapter.md -->
# My 🐱 cat journey
I love cats 🐱 and dogs 🐶, I have two, one's gray, like a raccoon 🦝 and the other one is black, like the night 🌃
Now, when you run mdbook build
, all your emojis will be converted.
🎡 Custom Emojis
You can use your own emojis as .svg
files. Just create a directory called custom_emojis
in src
; there you can include your custom emojis, like this:
.
├── book.toml
└── src
├── chapter_1.md
├── custom_emojis
│ └── myemoji.svg
└── SUMMARY.md
# Chapter 1
:myemoji:
These emojis will be automatically sized to the correct size.
Stargazers
License
This software uses the MIT License. Check the file LICENSE for more details
Dependencies
~14–25MB
~365K SLoC