Ruby/Furigana Support

[MichaelCharles]

I think it would be great if we had support for ruby, or as it is called in Japanese furigana.

Furigana are basically phonetic guide words that appear above written text, such as in the image below.

On the r/learnjapanese community on Reddit, for a long time they had a syntax for furigana in Markdown that made a lot of sense to me. It looked like this,

このように[振り仮名](#fg "ふりがな")を[使](#fg "つか")えます！

I'm currently writing a presentation in Japanese, and it would be really helpful it furigana were supported.

I know other languages use ruby/phonetic guides as well, so it would be potentially helpful even to those who aren't using Japanese.

Though I guess I can just do it in inline HTML?

<p>このように<ruby>振り仮名<rp>(</rp><rt>ふりがな</rt><rp>)</rp></ruby>を<ruby>使<rp>(</rp><rt>つか</rt><rp>)</rp></ruby>えます</p>

But that's kind of ugly and difficult to parse when editing.

[yhatt]

Marp's plugin architecture is just for that. You can add a custom furigana syntax to Marp by using markdown-it plugins: https://www.npmjs.com/search?q=markdown-it%20ruby

You must use Marp CLI whenever using any plugins.

Example: markdown-it-ruby

`markdown-it-ruby` を{使|つか}うと、このような{構文|こうぶん}を{使用|しよう}して、{漢字|かんじ}にルビを{振|ふ}ることができます。

Marp は{汎用性|はんようせい}の{高|たか}いエコシステムとして{設計|せっけい}されているため、CommonMark {外|がい}の Markdown {構文|こうぶん}に{関|かん}して、{独自|どくじ}の{意見|いけん}を{持|も}つことを{極力|きょくりょく}{避|さ}けています。{必要|ひつよう}に{応|おう}じて、ユーザーがプラグインを{使|つか}うことで Markdown {構文|こうぶん}が{拡張|かくちょう}されるべきです。

// engine.js
module.exports = ({ marp }) => marp.use(require('markdown-it-ruby'));

npm i --save markdown-it-ruby
marp --engine ./engine.js japanese.md

There are various suggestions about the furigana syntax in Markdown, and markdown-it-ruby is using the DenDenMarkdown style syntax. If you want the furigana support with the syntax you've described, you may have to write another markdown-it plugin: https://github.com/markdown-it/markdown-it/blob/master/docs/architecture.md