Something went wrong. Try again.
Annotate fonts with ruby (pinyin/romaji) and produce modified TTF/WOFF2 outputs.
Something went wrong. Try again.
Files
Verified signature Signed by lem.my SHA256:bngDbnD0BlRUkDO6ExMr630lPO0g478ldQSe7Es/gR4 Click to copy SHA
Verified signature Signed by lem.my SHA256:bngDbnD0BlRUkDO6ExMr630lPO0g478ldQSe7Es/gR4 Click to copy SHA
Verified signature Signed by lem.my SHA256:bngDbnD0BlRUkDO6ExMr630lPO0g478ldQSe7Es/gR4 Click to copy SHA
- Rust 99%
- Nix <1%
README.md
Rubify #
Annotate fonts with ruby (pinyin/romaji/hiragana) and produce modified TTF/WOFF2 outputs.

- Render ruby annotations using pluggable renderers (
pinyin,romaji,hiragana) - Word-level readings through bundled dictionaries, compiled into ligature and contextual rules, so 日本 reads にほん and 今日 reads きょう instead of per-character readings
- Subset output fonts to only include annotation characters
- Optionally split TTC into individual TTF files
- Optional WOFF2 output (feature-flagged, currently only supported when splitting collections)
Library Usage #
See the rubify crate documentation for API details and examples.
CLI Usage #
rubify <input-file-or-glob> -o <out-dir> --ruby <pinyin|romaji|hiragana> [options]
--out, -o <path>: Output directory (required)--ruby <pinyin|romaji|hiragana>: Which annotation renderer to use (requires building with the corresponding feature)--font <path>: Separate font file to use for ruby characters--words <path>: Word list file, added on top of the bundled dictionary.--dict <path>/--no-dict: Use a compiled dictionary file instead of the bundled one / use no bundled dictionary--bare <form>: Leave a form bare (repeatable)--subset: Subset output font to contain only annotated characters--split: When input is a TTC, write each font as a separate TTF file instead of rebuilding a TTC--woff2: Convert outputs to WOFF2--position <top|bottom|leftdown|leftup|rightdown|rightup>: Where to place ruby annotations relative to the base glyph. Valid values:top(default): place annotation above the base glyphbottom: place annotation below the base glyphleftdown: place annotation to the left, stacking downwardsleftup: place annotation to the left, stacking upwardsrightdown: place annotation to the right, stacking downwardsrightup: place annotation to the right, stacking upwards
--fit: Squeeze ruby horizontally so it stays inside the annotated character (or the whole word) when there is no room--fit-floor <ratio>: Lowest scale the fitting ruby is squeezed to; below it the ruby overhangs (default 0, which fits exactly)--adjust-metrics: Raise the ascender so ruby is not clipped by tight--common-only: Annotate only words in the frequency window line spacing--no-places,--no-untagged: Drop place names / unranked words--skip-jlpt <N5..N1>: Leave words of that level and easier bare--nf-min <n>/--nf-max <n>: Newspaper frequency bucket window--select-tags <tags>: Comma separated JMdict priority tags that select a word whatever its bucket--min-tatoeba <n>: Tatoeba uses that select a word whatever its bucket--scale <ratio>: Ruby size relative to the base characters--gutter <em>: Space between the base glyph and the ruby--offset <em>: Baseline offset for the ruby--tight: Per-character placement instead of a shared baseline
Examples #
rubify Sarasa-Regular.ttc -o dist --ruby pinyin --split
rubify *.ttc -o dist --font iosevka/IosevkaSlim-Regular.ttf --ruby romaji --position bottom --split --woff2
rubify NotoSansJP-Regular.ttf -o dist --ruby hiragana --common-only
Fonts made with Rubify #
Typefaces that ship Rubify-generated annotations:
License #
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)
at your option.
The bundled dictionaries are licensed under CC BY-SA 4.0, see data/LICENSE.md.