Japanese Novel Ruby Plugin for Obsidian

English | 日本語

Obsidian plugin for display & insert ruby(Furigana) ​​marks commonly used in Japanese novels.

The ruby syntax of this plugin is a format widely used by Japanese novel web sites, such as 「青空文庫」「小説家になろう」 and others.

Format example:

Input Text	Rendered Ruby
長い｜文章《ぶんしょう》	長い文章ぶんしょう
長い文章《ぶんしょう》	長い文章ぶんしょう
｜傍《・》｜点《・》	傍・点・

What you can do with this plugin

• Edit documents while previewing ruby
  • Enable / disable ruby preview in source mode via plugin settings.
  • Ruby can be enabled for specific notes only. (Turn on the option and set the property "enable_ruby: true") (from ver. 1.2.0)
  • You can change the ruby marks for non-Japanese novel use. e.g. 《》 → 【】 (from ver. 1.2.0)
• The user interface is available in English / Japanese / Simplified Chinese / Traditional Chinese.

• Commands:
  • novel-ruby-insert : Show a dialog to insert ruby. Set selected text as body.
  • novel-ruby-insert-direct : Insert ruby marks directly in the editor without opening a dialog.
  • novel-ruby-insert-dot : Insert emphasis dots in selected text.
  • novel-ruby-remove : Remove all ruby marks from selected text.
  • novel-ruby-toggle-ruby-hidden : Toggle 'Hide ruby unless hover' setting.

Limitations

• Using the half-width pipe | as a ruby start delimiter inside tables will break the display.
  • If you want to use ruby inside tables, please make sure to use the full-width pipe ｜.

See Also

This plugin doesn't support markdown ruby format.

If you want to use it, consider to use obsidian-markdown-furigana plugin.

Acknowledgments

Thanks to @steven-kraft. Part of the Ruby parsing code was inspired by obsidian-markdown-furigana plugin.

Thanks to @phibr0. The localization code is based on the obsidian-commander plugin.

Special thanks to @Moyf and @MinZe25 for their PRs and suggestions regarding the new features in ver. 1.2.0 and Simplified Chinese localization support!

Special thanks to @chungchungdev for the PR regarding Traditional Chinese localization support!

Support

If you like this plugin, please consider supporting my work. Thank you!