https://github.com/0918nobita/obsidian-zhongwen-block

An Obsidian plugin which provides code blocks with features for Chinese learners
https://github.com/0918nobita/obsidian-zhongwen-block

chinese hanyu obsidian obsidian-md obsidian-plugin obsidian-plugins zhongwen

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/0918nobita/obsidian-zhongwen-block
• Owner: 0918nobita
• License: mit
• Created: 2023-11-07T08:15:56.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-12T14:19:15.000Z (7 months ago)
• Last Synced: 2024-08-02T17:29:54.786Z (4 months ago)
• Topics: chinese, hanyu, obsidian, obsidian-md, obsidian-plugin, obsidian-plugins, zhongwen
• Language: TypeScript
• Homepage:
• Size: 881 KB
• Stars: 17
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.ja.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-obsidian-zh - 0918nobita/obsidian-zhongwen-block

README

        
# Obsidian Zhongwen Block

中国語学習者向けの機能を備えたコードブロックを提供する Obsidian プラグイン

`zh-cn` コードブロック内の各中国語文は、対応するピンインをルビとして付与したうえで表示されます。

発音を覚えるのを促すために、ピンインは中国語文にマウスホバーしている間だけ表示されます。

![Screen recording](images/screen-recording.gif)

編集ビュー:

````markdown

```zh-cn

他先去医院，再去学校。

```

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

````

リーディングビュー:

(デフォルト)

![Reading view (default)](images/reading-view-default.png)

(マウスホバー時)

![Reading view (on hover)](images/reading-view-on-hover.png)

## 設定

### 言語

デフォルト値: English

このプラグインでは、英語と日本語に対応しています。

### ピンインを常に表示する

デフォルト値: `false`

`true` の場合、最初からピンインが表示された状態になります。

## 帰属

-   中国語からピンインに変換するために、[pinyin-pro](https://github.com/zh-lx/pinyin-pro) を利用しています。

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2F0918nobita%2Fobsidian-zhongwen-block.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2F0918nobita%2Fobsidian-zhongwen-block?ref=badge_large&issueType=license)

## 開発

### ビルド

```bash

$ npm run build

```

### Lint

```bash

$ npm run lint

```

### ソースコードをフォーマットする

```bash

$ npm run format

```