This is a
playground to test code. It runs a full
Node.js environment and already has all of
npm’s 400,000 packages pre-installed, including
gem-furigana with all
npm packages installed. Try it out:
This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.
Gem is little library for working with Japanese furigana.
Japanese writing is made up of two phonetic scripts: hiragana for Japanese words and katakana for loan words. There is also a logographic script called kanji, where a single character represents an idea or a word. All three of these scripts are used in Japanese text.
Since kanji characters aren't phonetic, some Japanese texts show the pronunciation above the kanji characters. This is called furigana. It is often used for text aimed at children, but is very helpful for anyone learning the language. The furigana helpers are called gems.
The Gem library makes it easier to work with furigana text, particularly on web pages. You can:
The Gem library uses a simple syntax to encode furigana information in Japanese text. The text to be displayed in the furigana gem is simply included in square brackets following the character or group of characters it relates to.
Gem is an npm package, so you can install it into your project using the following command:
npm install gem-furigana
Then you can create furigana objects. Pass in the Japanese text with the extra furigana information encoded in Gem syntax.
const Furigana = require("gem-furigana").Furigana; var furigana = new Furigana("新[あたら]しい");
Then it's possible to generate:
const Furigana = require("gem-furigana").Furigana; var furigana = new Furigana("新[あたら]しい"); console.log(furigana.Reading); // 新[あたら]しい console.log(furigana.Expression); // 新しい console.log(furigana.Hiragana); // あたらしい console.log(furigana.ReadingHtml); // <ruby><rb>新</rb><rt>あたら</rt></ruby>しい