Markdown Furigana
approvedby Steven Kraft
Display furigana using Markdown syntax.
Markdown Furigana Plugin (Obsidian)
Simple markdown to furigana rendering plugin for displaying Japanese text with furigana in Obsidian (https://obsidian.md).
As of 1.2.0, the plugin is no longer limited to Japanese Text
Based off of markdown-it-ruby syntax. All rendering is done post-processing when previewing, so your notes are not modified.
Examples
| Markdown | Processed As | Displays As |
|---|---|---|
| {漢字|かんじ} | <ruby>漢字<rt>かんじ</rt></ruby> | 漢字 |
| {漢字|かん|じ} | <ruby>漢<rt>かん</rt>字<rt>じ</rt></ruby> | 漢字 |
| {北京|ㄅㄟˇ|ㄐㄧㄥ} | <ruby>北<rt>ㄅㄟˇ</rt>京<rt>ㄐㄧㄥ</rt></ruby> | 北京 |
| {北京|Běi|jīng} | <ruby>北<rt>Běi</rt>京<rt>jīng</rt></ruby> | 北京 |
| {韓國|한|국} | <ruby>韓<rt>한</rt>國<rt>국</rt></ruby> | 韓國 |
Additional Info
The plugin expects the first section to be Kanji or Kana, and furigana sections to be Hiragana or Katakana. If more than one furigana section, there must be as many as the number of characters in the first section. Sections of furigana can also be empty.
See Also
Also check out the Obsidian Furigana plugin if you prefer to use the ruby syntax directly in your notes.
For plugin developers
Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.