Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janstanleywatt/commonmark-furigana-extension
League/commonmark extension for japanese furigana.
https://github.com/janstanleywatt/commonmark-furigana-extension
Last synced: 9 days ago
JSON representation
League/commonmark extension for japanese furigana.
- Host: GitHub
- URL: https://github.com/janstanleywatt/commonmark-furigana-extension
- Owner: JanStanleyWatt
- License: apache-2.0
- Created: 2023-02-09T16:15:08.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-22T17:57:43.000Z (8 months ago)
- Last Synced: 2024-11-05T23:06:36.641Z (10 days ago)
- Language: PHP
- Size: 127 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CommonMark Furigana Extension
[Parsedownのルビ振り拡張機能](https://github.com/noisan/parsedown-rubytext)をリスペクトして作った、ルビ振り機能を追加するleague/commonmark用Extension
## 使い方
すでに[PHP](https://www.php.net/)と[composer](https://getcomposer.org/)を使用できる環境にあることを前提とします。
### インストール
1. このリポジトリをクローンする
1. なにがしかのシェルで`composer require jsw/commonmark-furigana-extension`と入力する
1. または、composer.jsonに以下の行を追加して`composer install`を実行
```
{
"require": {
"jsw/commonmark-furigana-extension":"*"
}
}
```
### ルビの振り方のルール
1. ルビを振りたい単語の前に「｜」、単語の後ろに「《（ルビ文字）》」を入れる
- 例:`シャッター破壊で｜Go Ahead《前進だ》！！`
-> `シャッター破壊でGo Ahead前進だ！！`
-> シャッター破壊でGo Ahead前進だ！！
1. ただし、文字種の違いでルビを振るべき単語を特定できる場合は「｜」を省略できる
- 例: すなわち、第四極《だいよんきょく》とは力なり
-> `すなわち、第四極だいよんきょくとは力なり`
-> すなわち、第四極だいよんきょくとは力なり
1. モノルビを表現する際には、そのつどルビを振る
- 例:`萌黄《もえぎ》白糸《しらいと》折鶴蘭《おりづるらん》`
-> `萌黄もえぎ白糸しらいと折鶴蘭おりづるらん`
-> 萌黄もえぎ白糸しらいと折鶴蘭おりづるらん
### 設定
```php
// 以下、デフォルトでの設定
$config = [
'sapphire' => [
'use_sutegana' => false, // trueにすると、ルビ文字のうち特定の小文字が大文字になる(ゅ→ゆ、ぁ→あ...etc)
'use_rp_tag' => false, // trueにすると、タグがルビにつく(（ルビ）)
]
];
```
### VS Code用スニペット
スニペット設定としてmarkdown.jsonを、スニペット用キーバインドとしてkeybindings.jsonを添付しました。機能は以下の通りです。
- Markdownファイルの編集中にスニペット「aozora_ruby」を実行すると、カーソルを挟むようにルビ記号（《》）が挿入される
- ルビ文字を入力後にtabキーを押下することで、ルビ記号の直後にカーソルが移動するようになる
- 文字を選択している状態でスニペット「aozora_ruby_separate」を実行すると、選択した文字を親文字と認識し、親文字の直前に区切り文字（｜）を、直後にルビ記号（《》）が挿入される
- カーソルの振る舞いは「aozora_ruby」に準ずる
- keybindings.jsonの設定を有効にすると、Ctrl+rでスニペット「aozora_ruby」を実行するようになる
- 条件は以下の3つ:
- 編集画面を選択中
- 編集しているファイルをMarkdownとVS Codeが認識している
- ファイルは読み取り専用**ではない**
- 文字を選択した状態でCtrl+rを入力すると、「aozora_ruby_separate」が実行される
- 条件は「aozora_ruby」に準ずる
## ライセンス
Apache License, Version 2.0
- [英語原文](https://www.apache.org/licenses/LICENSE-2.0)
- [日本語参考訳](https://licenses.opensource.jp/Apache-2.0/Apache-2.0.html)