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

bash $ cd mdbook-emojicodes; cargo install --path .

:question: Usage

Write this in your book.toml:

toml [preprocessor.emojicodes]

Now, ✨ It's ready to use! ✨.

You can use emojis by writing an emojicode in your files.

Example

```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 :nightwithstars:. ```

This will render to:

```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.

Stargazers

License

This software uses the MIT License. Check the file LICENSE for more details