An MkDocs plugin to add pinyin/furigana to Chinese/Japanese Kanji text.
Project description
mkdocs-ruby-plugin
An MkDocs plugin to add pinyin/furigana to Chinese/Japanese Kanji text.
It's based on https://github.com/ijaureguialzo/mkdocs-furigana-plugin, but replace CSS style with HTML <ruby>
tag.
Installation
pip3 install mkdocs-ruby-plugin
Or
pip3 install https://github.com/lesliezhu/mkdocs-ruby-plugin/archive/refs/heads/master.zip
Usage
Write kanji like this:
我(wo)是一只{猫(mao)}。猫(ねこ).
It will look like:
我wo是一只猫mao。猫ねこ.
Or like this when there is more than one character:
我(wo)是{一只猫(yizhimao)}。{綺麗猫(きれいねこ)}.
It will look like:
我wo是一只猫yizhimao。綺麗猫きれいねこ.
To enable the plugin in the mkdocs.yml
file:
plugins:
- ruby:
global_enable: True
outer_begin: '{'
outer_end: '}'
inter_begin: '('
inter_end: ')
If ruby.global_enable = False
, you can enable this plugin in single page:
---
ruby: true
---
If ruby.global_enable = True
, you can disable this plugin in single page:
---
ruby: false
---
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs_ruby_plugin-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 993b37490254c7c425709122e56040558375d8c29b5f2720ca8a27105a9a3a7c |
|
MD5 | b108091e615a18289389b93340b55a15 |
|
BLAKE2b-256 | 178cebb5216ee51a2744f36b2a58f349d01f25ae7f0b0424992b4170c17c2606 |