Proper ruby text (<rb>) syntax support in Markdown

Extensions
39

Hello everyone,

I published a ruby library that supports ruby element in Markdown.

The syntax I chose is

[漢字(かんじ)]

Reasons being:

  • It looks like Markdown
  • It does not need to type any special brackets 【】
  • You can annotate each character
  • Linkify ruby text is the same as how you would do it in Markdown
An example
[漢字(かんじ)](https://jisho.org/search/漢字)

# Annotate each character
[漢(かん)][字(じ)]

# Link separately
[漢(かん)](https://jisho.org/search/漢)[字(じ)](https://jisho.org/search/字)

# Link together
[[漢(かん)][字(じ)]](https://jisho.org/search/漢字)

You can see how above renders at here. I have been using this to write 150 posts involves ruby markups and it works fine.

Hope this helps!

3 Likes