@mirrordown/mdit-ruby

Part of Mirrordown — a suite of markdown syntax extensions for the unified and markdown-it ecosystems.

A markdown-it plugin for the ruby syntax extension.

Overview

The ruby plugin renders {base|reading} as HTML <ruby> annotations, used for pronunciation guides in East Asian text.

<ruby>base<rt>reading</rt></ruby>

Syntax

Use {base text|reading} inline to annotate characters with their pronunciation or reading:

{漢字|かんじ} are Chinese-derived characters used in Japanese writing.

{東京|とうきょう} is the capital of Japan.

Optionally pass rp parentheses for fallback rendering in unsupported browsers:

Install

npm install @mirrordown/mdit-ruby

Standalone

import MarkdownIt from "markdown-it";
import { ruby } from "@mirrordown/mdit-ruby";

const md = new MarkdownIt().use(ruby);

VitePress

// .vitepress/config.ts
import { defineConfig } from "vitepress";
import { ruby } from "@mirrordown/mdit-ruby";

export default defineConfig({
  markdown: {
    config: (md) => md.use(ruby)
  }
});

Documentation

Full documentation, more examples, and configuration options: github.com/mirrordown/mirrordown (dedicated docs site coming soon).

License

MIT © Drake Costa