sphinx-nekochan
¶
A Sphinx extension for adding the Nekochan(cat) emoji to documents.
Hint
See Description in Japanese . 日本語の説明は Description in Japanese を参照してください。
Hint
Sample slide with Nekochan emoji (using sphinx-revealjs).
Get Started
¶
1. Installation
¶
You can install sphinx-nekochan
with pip
:
pip install sphinx-nekochan
2. Enable extension
¶
In your conf.py
configuration file, add sphinx_nekochan
to your extensions list:
extensions = [
...
"sphinx_nekochan",
...
]
3. Use nekochan
role
¶
When you use the nekochan
roll, you will see any Nekochan emoji.
Welcome to Nekochan emoji {nekochan}`banzai` world!!
* Enjoy Nekochan emoji {nekochan}`ok`
* I love {nekochan}`beer`
Welcome to Nekochan emoji {nekochan}`banzai` world!!
* Enjoy Nekochan emoji {nekochan}`ok`
* I love {nekochan}`beer`
Welcome to Nekochan emoji world!!
Enjoy Nekochan emoji
I love
4. Customize emoji height and alt text
¶
You can specify height and alt text with a semicolon(;
) after the name of the nekochan
role.
* Big bear nekochan {nekochan}`kuma-nya;2em`
* Huge hot-sprint nekochan {nekochan}`hot-spring;128px`
* Customize alt text for emoji {nekochan}`gohan-taberu;3em;Nekochan eating rice ball`
* Big bear nekochan :nekochan:`kuma-nya;2em`
* Huge hot-sprint nekochan :nekochan:`hot-spring;128px`
* Customize alt text for emoji :nekochan:`gohan-taberu;3em;Nekochan eating rice ball`
Big bear nekochan
Huge hot-sprint nekochan
Customize alt text for emoji
License
¶
sphinx-nekochan is licensed under the MIT License.
Please refer to the following guidelines for using Nekochan emojis.