{"id":17925341,"url":"https://github.com/blyxyas/mdbook-emojicodes","last_synced_at":"2025-03-24T03:31:05.699Z","repository":{"id":65154797,"uuid":"584751853","full_name":"blyxyas/mdbook-emojicodes","owner":"blyxyas","description":"MDBook preprocessor for converting emojicodes (e.g. `: cat :`) into emojis 🐱","archived":false,"fork":false,"pushed_at":"2023-09-21T11:17:52.000Z","size":53,"stargazers_count":12,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-19T01:11:40.691Z","etag":null,"topics":["emoji","emoji-unicode","emojis","mdbook","mdbook-preprocessor"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/mdbook-emojicodes","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blyxyas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2023-01-03T12:29:56.000Z","updated_at":"2024-10-13T20:19:34.000Z","dependencies_parsed_at":"2023-02-18T08:35:14.557Z","dependency_job_id":null,"html_url":"https://github.com/blyxyas/mdbook-emojicodes","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blyxyas%2Fmdbook-emojicodes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blyxyas%2Fmdbook-emojicodes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blyxyas%2Fmdbook-emojicodes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blyxyas%2Fmdbook-emojicodes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blyxyas","download_url":"https://codeload.github.com/blyxyas/mdbook-emojicodes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245204493,"owners_count":20577360,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["emoji","emoji-unicode","emojis","mdbook","mdbook-preprocessor"],"created_at":"2024-10-28T20:53:29.982Z","updated_at":"2025-03-24T03:31:05.457Z","avatar_url":"https://github.com/blyxyas.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003emdbook-emojicodes\u003c/h1\u003e\n\n---\n\n`mdbook-emojicodes` is a MDBook preprocessor to replace your emojicodes (e.g. `:cat:`) to emojis. No more copy-pasting!\n\n## 📦 Installation\n\n### Using crates.io\n\n```\n$\tcargo install mdbook-emojicodes\n```\n\n### Manual installation\n\n#### Clone the repo\n\n```\n$\tgit clone https://github.com/blyxyas/mdbook-emojicodes\n```\n\n#### Build \u0026 Install the preprocessor\n\n```bash\n$\tcd mdbook-emojicodes;\n\tcargo install --path .\n```\n\n## ❓ Usage\n\nWrite this in your `book.toml`:\n\n```toml\n[preprocessor.emojicodes]\n```\n\nNow, **✨ It's ready to use! ✨**.\n\nYou can use emojis by writing an emojicode in your files.\n\n### Example\n\n```md\n\u003c!-- my_chapter.md --\u003e\n\n# My :cat: cat journey\n\nI 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:.\n```\n\nThis will render to:\n\n```md\n\u003c!-- my_chapter.md --\u003e\n\n# My 🐱 cat journey\n\nI love cats 🐱 and dogs 🐶, I have two, one's gray, like a raccoon 🦝 and the other one is black, like the night 🌃\n```\n\n---\n\nNow, when you run `mdbook build`, all your emojis will be converted.\n\n## 🎡 Custom Emojis\n\nYou 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:\n\n```\n.\n├── book.toml\n└── src\n    ├── chapter_1.md\n    ├── custom_emojis\n    │   └── myemoji.svg\n    └── SUMMARY.md\n```\n\n```md\n# Chapter 1\n:myemoji:\n```\n\nThese emojis will be automatically sized to the correct size.\n\n---\n\n#### Stargazers\n\n[![Stargazers repo roster for @blyxyas/mdbook-emojicodes](https://reporoster.com/stars/blyxyas/mdbook-emojicodes)](https://github.com/blyxyas/mdbook-emojicodes/stargazers)\n\n#### License\n\nThis software uses the **MIT License**. Check the file [LICENSE](https://github.com/blyxyas/mdbook-emojicodes/blob/master/LICENSE) for more details\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblyxyas%2Fmdbook-emojicodes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblyxyas%2Fmdbook-emojicodes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblyxyas%2Fmdbook-emojicodes/lists"}