README file from
GithubJapanese Helper for Obsidian
An Obsidian plugin to streamline Japanese note-taking with romaji to kana conversion.
Features
- Convert romaji to hiragana - Quickly convert selected Latin text (romaji) to hiragana
- Convert romaji to katakana - Easily convert selected Latin text (romaji) to katakana
- Customizable keyboard shortcuts - Set your preferred hotkeys for quick access
- Simple and intuitive - Works with your selected text right in the editor
Usage
- Select romaji text in your note (e.g.,
watashi-ga keeki-wo taberu) - Use one of the following methods to convert:
- Press
Ctrl+Alt+Hto convert to hiragana - Press
Ctrl+Alt+Kto convert to katakana - Use the command palette and search for "Convert to Hiragana" or "Convert to Katakana"
- Press
Examples
- Romaji:
watashi-ga keeki-wo taberu - Hiragana:
わたしがけえきをたべる - Katakana:
ワタシガケエキヲタベル
Japanese Text Specifics Handled
- Small letters (e.g., っ, ゃ, ゅ, ょ)
- Particles (e.g., は, を, が)
- Long vowels
- Double consonants
Installation
- Open Obsidian
- Go to Settings > Community plugins
- Disable Safe mode if it's enabled
- Click "Browse" and search for "Japanese Helper"
- Install the plugin
- Enable the plugin after installation
Configuration
In the plugin settings, you can:
- Customize the hotkeys for converting to hiragana/katakana
- Toggle whether to show notification after conversion
Feedback & Support
If you encounter any issues or have suggestions for improvements, please create an issue on the GitHub repository.
License
BSD Zero Clause License