Ruby

CJK テキストにルビ注釈を追加し、インラインのキャレット構文をネイティブの HTML ルビマークアップへ描画します。

ruby 機能は CJK テキストに読み仮名（ルビ）注釈を追加し、インライン構文を標準の HTML <ruby> マークアップへと描画します。

設定

ruby キーで機能を有効化します。true のショートハンドを受け付けます。

export default defineConfig({
  markdown: {
    features: {
      ruby: true,
    },
  },
});

構文

注釈は、ベーステキストの直後にキャレットと波括弧で読みを記述する形式です — {base}^{ruby}。ベースはキャレットの直前にある連続した文字列です。

日本語^{にほんご}

ライブ例

上記のソースを、このページのパイプラインで描画した結果です。

日本語にほんご

HTML 出力

注釈は意味のある <ruby> マークアップとして描画されます。

<ruby><rb>日本語</rb><rt>にほんご</rt></ruby>

スコープ

この機能は明示的な {base}^{ruby} 構文のみを解析します。漢字の自動検出や形態素解析によるふりがなの自動付与は行いません — これは意図的にスコープ外としています。ベースはキャレット直前の連続した文字から貪欲に取られるため、注釈の範囲を狭めたい場合は前のテキストとの間に区切りを入れてください。