Markdown on ruby markup

Design a better syntax of ruby markup for Markdown

The <ruby> HTML element represents small annotations that are rendered above, below, or next to base text, usually used for showing the pronunciation of Japanese and Chinese characters. There is a <ruby> markup syntax discussion in the CommonMark Discussion, among which, I prefer the syntax designed by JuanitoFatas.


The benefits are obvious:

  1. The markup looks pretty and easy to understand
  2. It works well together with links

However, the syntax for separated ruby annotations is a little complex:


While in mistune v3, I've added a ruby plugin for multiple annotations with the below syntax:


You can group all ruby texts in [] which can reduce the use of punctuation characters.

Typlog has been updated with mistune v3, you can use ruby syntax right now in Typlog. Here are the rendered results with the ruby markup syntax:

ㄏㄢˋㄗˋ with zhuyin, hàn with pinyin, and かん with hiragana.