# Komaki Furigana
**Japanese Furigana Annotation Plugin for Obsidian**
**日本語假名标注插件 | Obsidian 用ふりがな注釈プラグイン**
**Author / 作者 / 作者:** komaki
**Version / 版本 / バージョン:** 1.0.0
**License / 许可证 / ライセンス:** MIT
**Languages:** [English](#english) | [简体中文](#简体中文) | [日本語](#日本語)
---
# English
## Overview
**Komaki Furigana** is an Obsidian plugin for manually adding, editing, and removing Japanese furigana annotations using standard HTML Ruby markup.
Select Japanese text, enter its reading, and save the annotation directly into your Markdown notes.
```html
日本語
```
No Templater, account, internet connection, or API key is required. The plugin is precompiled, so ordinary users do not need Node.js.
### Features
- Add and edit furigana annotations.
- Remove furigana while preserving the original text.
- Annotate multiple words in a single operation.
- Preview annotations before saving.
- Show or hide readings for self-testing.
- Customize reading size and position.
- Convert entered readings between hiragana and katakana.
- Support existing standard HTML Ruby annotations.
- Work offline without telemetry or external requests.
## Installation
Komaki Furigana is currently available for **manual installation only**. It has not yet been published in the official Obsidian Community Plugins directory.
1. Extract the downloaded ZIP archive.
2. Locate the `komaki-furigana` folder.
3. Copy it into your vault's `.obsidian/plugins/` directory.
4. Verify that the following files exist:
```text
YourVault/
└── .obsidian/
└── plugins/
└── komaki-furigana/
├── main.js
├── manifest.json
└── styles.css
```
5. Restart Obsidian.
6. Open **Settings → Community plugins**.
7. Enable community plugins if necessary, then enable **Komaki Furigana**.
Make sure the plugin folder is not accidentally nested inside another folder with the same name.
On macOS, press **⌘ + Shift + .** in Finder to show hidden files.
If your vault uses a custom configuration folder instead of `.obsidian`, use that folder.
Mobile installation follows the same directory structure. However, the plugin has not yet been fully tested on actual Android or iOS devices.
## Quick Start
1. Open a note in editing mode.
2. Select `日本語`.
3. Open the Command Palette with **Ctrl + P** (Windows/Linux) or **⌘ + P** (macOS).
4. Search for `Komaki Furigana`.
5. Run **Add / Edit Furigana**.
6. Enter `にほんご` in the reading field.
7. Review the preview and press **Enter** or click **Save Annotation**.
You can also use the editor context menu or the ribbon icon.
When no text is selected, the dialog allows you to enter both the original text and its reading. The result is inserted at the original cursor position.
Pressing **Esc** or cancelling the dialog does not modify the note. An empty reading does not overwrite the original text.
## Editing and Removing Annotations
### Edit an existing annotation
Place your cursor inside an existing `...` element, or select its original text, and run **Add / Edit Furigana**.
The dialog automatically loads the existing text and reading. Saving updates that annotation.
### Remove an annotation
Place your cursor inside a Ruby annotation and run **Remove Furigana (Keep Text)**.
Alternatively, click **Remove Annotation** in the editing dialog.
You can also select a block containing multiple complete Ruby annotations and remove their readings together.
If the selection cuts through multiple annotations without including them completely, the plugin asks you to adjust the selection.
Ordinary operations can be reversed using Obsidian's Undo command. Batch insertion and removal are handled as single text edits.
Existing Ruby annotations created with Templater are supported without migration.
Complex Ruby markup containing multiple `