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
      title_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
---