Package Exports
- @being-ish/textlint-rule-kanji-needs-ruby
- @being-ish/textlint-rule-kanji-needs-ruby/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@being-ish/textlint-rule-kanji-needs-ruby) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@being-ish/textlint-rule-kanji-needs-ruby
漢字にルビが振られているかチェックするルール
チェック内容
ルビは HTML の ruby 要素で振ることを前提としています。
また、 ruby 要素の子として rt 要素がなければ意味がないため、 rt 要素を持たない ruby 要素はエラーとなります。
使用方法
次のコマンドでインストールします。
npm install --save-dev @being-ish/textlint-rule-kanji-needs-rubytextlint の設定ファイルに次の指定を追加します。
{
"rules": {
"@being-ish/kanji-needs-ruby": true
}
}正しい書き方
<ruby>漢字<rt>かんじ</rt></ruby>間違った書き方
シンプルなケース
漢字ルビが振られていません。
有効なルビが振られていないケース
<ruby>漢字</ruby>rt 要素がないため、有効なルビではありません。
インラインコードにルビを振るケース
`漢字`インラインコードであっても漢字にはルビを振ってください。次のように書くと良いでしょう。
<ruby>`漢字`<rt>`かんじ`</rt></ruby>