rubyAnnotation()

import { rubyAnnotation } from "@unifast/node";

Signature

function rubyAnnotation(): UnifastPlugin

Paramètres

Aucun.

Utilisation

import { compile, rubyAnnotation } from "@unifast/node";

const md = `
{漢字|かんじ}の読み方を学びましょう。
`;

const result = compile(md, { plugins: [rubyAnnotation()] });
// {漢字|かんじ} becomes <ruby>漢字<rp>(</rp><rt>かんじ</rt><rp>)</rp></ruby>

Exemples

Annotations ruby (furigana)

Plusieurs annotations dans une phrase

import { compile, rubyAnnotation } from "@unifast/node";

const md = `
{東京|とうきょう}は{日本|にほん}の{首都|しゅと}です。
`;

const result = compile(md, { plugins: [rubyAnnotation()] });

Contenu mixte

import { compile, rubyAnnotation } from "@unifast/node";

const md = `
# {日本語|にほんご}ガイド

{漢字|かんじ}には**たくさん**の{読|よ}み{方|かた}があります。

- {音読|おんよ}み — Chinese-derived reading
- {訓読|くんよ}み — Native Japanese reading
`;

const result = compile(md, { plugins: [rubyAnnotation()] });