README

尊重Parsedownのルビ振り拡張機能开发的league/commonmark扩展，用于添加假名功能

使用方法

假设您已经拥有可以使用PHP和composer的环境。

安装

克隆此存储库
在任何shell中输入composer require jsw/commonmark-furigana-extension
1. 或者，将以下行添加到composer.json中，然后执行composer install
```
{
    "require": {
        "jsw/commonmark-furigana-extension":"*"
    }
}
```

假名标注规则

在想要标注假名的单词前加上「｜」，在单词后加上「《（假名字符）》」
- 例:シャッター破壊で｜Go Ahead《前進だ》！！
  -> シャッター破壊で<ruby>Go Ahead<rt>前進だ</rt></ruby>！！
  -> シャッター破壊で！！
如果可以通过文字种类差异来识别需要标注假名的单词，则可以省略「｜」
- 例: すなわち、第四極《だいよんきょく》とは力なり
  -> すなわち、<ruby>第四極<rt>だいよんきょく</rt></ruby>とは力なり
  -> すなわち、とは力なり
表示单字假名时，每次都需要标注假名
- 例:萌黄《もえぎ》白糸《しらいと》折鶴蘭《おりづるらん》
  -> <ruby>萌黄<rt>もえぎ</rt></ruby><ruby>白糸<rt>しらいと</rt></ruby><ruby>折鶴蘭<rt>おりづるらん</rt></ruby>
  ->

设置

// 以下、デフォルトでの設定
$config = [
    'sapphire' => [
        'use_sutegana' => false,    // trueにすると、ルビ文字のうち特定の小文字が大文字になる(ゅ→ゆ、ぁ→あ...etc)
        'use_rp_tag' => false,      // trueにすると、<rp>タグがルビにつく(<rp>（</rp><rt>ルビ</rt><rp>）</rp>)
    ]
];

VS Code用スニペット

作为snippets配置，添加了markdown.json，作为snippets的键绑定配置了keybindings.json。功能如下。

在Markdown文件编辑时执行snippets「aozora_ruby」，将插入夹在光标中的假名标记（《》）
- 输入假名文字后按tab键，光标将移动到假名标记（《》）的后面
选中文字后执行snippets「aozora_ruby_separate」，将选中文字识别为基文字，在基文字前插入分隔符（｜），在后面插入假名标记（《》）
- 光标的操作与「aozora_ruby」相同
启用keybindings.json的设置后，可以通过Ctrl+r执行snippets「aozora_ruby」
- 条件如下
  - 选择编辑画面
  - VS Code识别正在编辑的文件为Markdown
  - 文件不是只读的
选中文字后输入Ctrl+r将执行「aozora_ruby_separate」
- 条件与「aozora_ruby」相同

许可证

Apache License, Version 2.0

jsw / commonmark-furigana-extension

维护者

详细信息

README

使用方法

安装

假名标注规则

设置

VS Code用スニペット

许可证