Skip to content

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

License

Notifications You must be signed in to change notification settings

0918nobita/obsidian-zhongwen-block

Repository files navigation

Obsidian Zhongwen Block

README-ja

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.

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

Screen recording

Editing view:

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

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

Reading view:

(Default)

Reading view (default)

(On hover)

Reading view (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.

FOSSA Status

Development

Build

$ npm run build

Lint

$ npm run lint

Format

$ npm run format