@azamiharu/marked-aozora-ruby

青空文庫ライクなルビ（｜漢字《かんじ》 または 漢字《かんじ》）をサポートする marked 拡張機能です。

使い方

import { markedAozoraRuby } from "@azamiharu/marked-aozora-ruby";
import { marked } from "marked";

marked.use(markedAozoraRuby());

const html = marked.parse("漢字《かんじ》");
// <p><ruby>漢字<rp>《</rp><rt>かんじ</rt><rp>》</rp></ruby></p>

変換仕様

• 明示的な開始記号: ｜（全角）または |（半角）[^1] を使用すると、その直後から 《 までをルビ対象とします。
• 自動認識: 開始記号がない場合、《 の前後にある同一文字種（漢字、ひらがな、カタカナ、アルファベット）の連続を自動的にルビとして認識します。
  • 注意1: 漢字とひらがなが混在する場合（例：食べ物《たべもの》）は、直前の同一文字種のみが抽出されます（この例では 物 だけがルビ対象となります）。送り仮名を含む単語全体にルビを振る場合は、｜食べ物《たべもの》 のように開始記号を使用してください。
  • 注意2: ひらがなとカタカナは別種です。混在する場合（例：一弗《いちドル》）は、《 〜 》 をルビ注釈として認識しません。｜一弗《いちドル》 のように開始記号を使用するか、一《いち》弗《ドル》 のように分割してください。
• エスケープ: ｜《 または |《 は、記号としての 《 に変換されます[^1]。

詳細な挙動

• インライン装飾: ルビ対象（｜ 〜 《 の間）には、強調などの Markdown インライン要素を含めることができます。
  • 注意: ルビ注釈（《 〜 》 の間）には含めることができません。
• HTMLエスケープ: ルビ内の < や & などの特殊文字は安全にエスケープされます。

[^1]: |（半角） ｜《 |《 は青空文庫注記の仕様ではありませんが、複数の有名な小説投稿サイトで採用されているため、実用性を重視して実装しています。