Obsidian Zhongwen Block

An Obsidian plugin which provides code blocks with features for Chinese learners

Each Chinese sentence in zh-cn code block will be annotated with corresponding pinyin as ruby.

Each Chinese sentence in zh-hk code block will be annotated with corresponding jyutping as ruby.

In order to help you remember the pronunciation, each pinyin/jyutping is displayed only while the Chinese sentence is hovered.

Editing view:

```zh-cn
他先去医院，再去学校。
```

彼女はまず病院に行って、次に学校に行きます。

Reading view:

(Default)

(On hover)

Settings

Language

Default: English

This plugin supports English and Japanese.

Always show pinyin

Default: false

When true, each pinyin will be displayed from the beginning.

Attribution

• Zhongwen Block depends on pinyin-pro in order to convert Chinese into pinyin.
• Zhongwen Block depends on to-jyutping in order to convert Chinese into jyutping.

Development

Install dependencies

$ bun i

Build

$ bun run build

Lint/format check

$ npm run check

Test

$ bun test