| 1 | --- |
| 2 | tags: [notes, presenter] |
| 3 | description: Automatically add `<ruby>` tags to your notes. |
| 4 | --- |
| 5 | |
| 6 | # Notes Auto Ruby |
| 7 | |
| 8 | > Available since v52.4.0 |
| 9 | |
| 10 | 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. |
| 11 | |
| 12 | In the headmatter, you can set the `notesAutoRuby` option to a map of words to their ruby text: |
| 13 | |
| 14 | ```md |
| 15 | --- |
| 16 | notesAutoRuby: |
| 17 | 日本語: ni hon go |
| 18 | 勉強: べんきょう |
| 19 | --- |
| 20 | |
| 21 | # Your slides here |
| 22 | |
| 23 | <!-- |
| 24 | 私は日本語を勉強しています。 |
| 25 | --> |
| 26 | ``` |
| 27 | |
| 28 | And the notes will be rendered as: |
| 29 | |
| 30 | <p>私は<ruby>日本語<rt>ni hon go</rt></ruby>を<ruby>勉強<rt>べんきょう</rt></ruby>しています。</p> |
| 31 |