https://github.com/blyxyas/mdbook-emojicodes

MDBook preprocessor for converting emojicodes (e.g. `: cat :`) into emojis 🐱
https://github.com/blyxyas/mdbook-emojicodes

emoji emoji-unicode emojis mdbook mdbook-preprocessor

Last synced: 9 days ago
JSON representation

MDBook preprocessor for converting emojicodes (e.g. `: cat :`) into emojis 🐱

• Host: GitHub
• URL: https://github.com/blyxyas/mdbook-emojicodes
• Owner: blyxyas
• License: mit
• Created: 2023-01-03T12:29:56.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-09-21T11:17:52.000Z (about 1 year ago)
• Last Synced: 2024-10-08T15:20:53.558Z (30 days ago)
• Topics: emoji, emoji-unicode, emojis, mdbook, mdbook-preprocessor
• Language: Rust
• Homepage: https://crates.io/crates/mdbook-emojicodes
• Size: 51.8 KB
• Stars: 11
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
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 .

```

## ❓ 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 :night_with_stars:.

```

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.

## 🎡 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

```

```md

# Chapter 1

:myemoji:

```

These emojis will be automatically sized to the correct size.

---

#### Stargazers

[![Stargazers repo roster for @blyxyas/mdbook-emojicodes](https://reporoster.com/stars/blyxyas/mdbook-emojicodes)](https://github.com/blyxyas/mdbook-emojicodes/stargazers)

#### License

This software uses the **MIT License**. Check the file [LICENSE](https://github.com/blyxyas/mdbook-emojicodes/blob/master/LICENSE) for more details