#japanese #localization #document #furigana #generate #format #automatic

app autoruby-cli

CLI to easily generate furigana for various document formats

8 releases (4 breaking)

0.5.1 Oct 25, 2023
0.5.0 Oct 25, 2023
0.4.0 Jun 6, 2023
0.3.2 May 23, 2023
0.1.0 Feb 1, 2023

#746 in Text processing

GPL-3.0-only

52KB
790 lines

autoruby-cli

Automatically generate furigana/ruby for various document formats.

Usage

Input and output paths specified, Markdown (include common)

$ cat ./input.txt
神は「光あれ」と言われた。すると光があった。

$ autoruby annotate ./input.txt ./output.md --format markdown -c
$ cat ./output.md
[神]{かみ}は「[光]{ひかり}あれ」と[言]{い}われた。すると[光]{ひかり}があった。

Input and output paths specified, Markdown (include common, only first occurrence)

$ cat ./input.txt
神は「光あれ」と言われた。すると光があった。

$ autoruby annotate ./input.txt ./output.md -f md -c1
$ cat ./output.md
[神]{かみ}は「[光]{ひかり}あれ」と[言]{い}われた。すると光があった。

STDIN→STDOUT, HTML

$ echo '宮崎のマンゴーとても美味しいです。' | autoruby annotate --format html
<ruby>宮<rp>(</rp><rt>みや</rt><rp>)</rp></ruby><ruby>崎<rp>(</rp><rt>ざき</rt><rp>)</rp></ruby>のマンゴーとても美味しいです。

STDIN→STDOUT, LaTeX

$ echo '千と千尋の神隠し' | autoruby annotate --format latex
千と\ruby{千}{ち}\ruby{尋}{ひろ}の\ruby{神}{かみ}\ruby{隠}{かく}し

STDIN→STDOUT, Markdown (include common, use katakana)

$ echo '駅は何処ですか。' | autoruby annotate -f markdown -ck
[駅]{エキ}は[何処]{ドコ}ですか。

Authors

Dependencies

~15–21MB
~416K SLoC