sphinx-contrib/emojicodes
An extension to use emoji codes in your Sphinx documentation! 😍
Thêm emoji vào tài liệu Sphinx chỉ bằng một vài ký tự
Dùng mã emoji |:smile:| ngay trong RST, tự động chuyển thành hình ảnh đẹp.
emojicodes (cài qua gói sphinxemoji) là một tiện ích mở rộng cho Sphinx, cho phép bạn chèn emoji vào tài liệu bằng cú pháp |tên_mã_emoji|. Dự án tích hợp sẵn bộ mã emoji từ Twemoji, hỗ trợ cấu hình nguồn và phong cách hiển thị.
✨ Điểm nổi bật
- Cài đặt nhanh:
pip install sphinxemoji, bật extension trongconf.py. - Cú pháp đơn giản: viết
|tên_mã|trong file RST để chèn emoji. - Tích hợp Twemoji: mặc định dùng bộ emoji từ Twitter (Twemoji).
- Cấu hình phong cách: chọn
sphinxemoji_style = 'twemoji'trongconf.py. - Tùy chỉnh nguồn: dùng
sphinxemoji_sourceđể chỉ định CDN hoặc file local. - Xử lý sau substitution mặc định: emoji chạy sau
|release|,|version|,|today|nhưng trước substitution khác.
💡 Vì sao đáng chú ý
Thay vì phải chèn ảnh emoji thủ công hoặc dùng ký tự Unicode không đồng đều, emojicodes mang đến cách viết nhanh và nhất quán trong suốt tài liệu Sphinx. Phù hợp cho tài liệu kỹ thuật, hướng dẫn người dùng, hoặc bất kỳ dự án nào muốn thêm sinh động bằng emoji mà không phức tạp hoá quy trình build.
#Sphinx #Emoji #Documentation #Python #Twemoji #TiniX
Similar Projects
Discover other similar projects and AI models.
🤗 Transformers: the model-definition framework for state-of-the-art machine learning models in text, vision, audio, and multimodal models, for both inference and training.
:octocat: 分享 GitHub 上有趣、入门级的开源项目。Share interesting, entry-level open source projects on GitHub.
Free domain registration and practical DNS learning resources for everyone.
:house_with_garden: Open source home automation that puts local control and privacy first.
An extended commonmark compliant parser, with bridges to docutils/sphinx