slidevjs__slidev/docs/features/notes-auto-ruby.md

tags, description

tags	description
notes presenter	Automatically add `<ruby>` tags to your notes.

Notes Auto Ruby

Available since v52.4.0

When you write notes in your slides, you might want to add some ruby text to help pronouncing the some words. You can always add <ruby> tags to your notes manually, but Slidev also provides a convenient way to do this automatically by a global auto-replacement.

In the headmatter, you can set the notesAutoRuby option to a map of words to their ruby text:

---
notesAutoRuby:
  日本語: ni hon go
  勉強: べんきょう
---

# Your slides here

<!--
私は日本語を勉強しています。
-->

And the notes will be rendered as:

私は日本語ni hon goを勉強べんきょうしています。