README file from
Github🏮 Chinese Popover Dictionary for Obsidian
💎 Popover & Character Anatomy
- Apple Liquid Glass UI — Translucent frosted glass card with fluid blur, draggable header bar, and pin (📌) to freeze on screen.
- Character Anatomy & 214 Radicals — Click any character chip in compound words to reveal its Kangxi radical, stroke count, meaning, and etymological components (
宀 + 子). - Ultra-Compact Action Palette — 34px icon-only quick dock (
📋,⭐,📌,📝,🖌️,✕) that never spills over or hides prematurely. - Dual English & Russian Translations — Choose English (CC-CEDICT), Russian (BKRS), or both simultaneously.
- Dual Phonetics & Tone Colors — Mandarin diacritic Pinyin + Cantonese Jyutping (
粵) with customizable tone colors.
📚 Study Ecosystem & Flashcards
- Permanent Personal Vocabulary Book — Star difficult words (
⭐) into a clean Markdown note in your vault (Chinese Vocabulary.md). - Spaced Repetition (SRS Flashcards) — Built-in SM-2 intervals (Again 1d, Hard 3d, Good 7d, Easy 14d) with due review filters.
- Spotlight Quick Search (
Alt + S) — Instant modal to search 118,000+ words by Hanzi (你好), Pinyin (nihao), Jyutping, or Russian/English. - 1-Click Anki Sync — Push cards directly into desktop Anki via AnkiConnect or export offline
.tsvdecks. - Pleco Mobile Export — Export vocabulary directly to Pleco
.txtformat for flashcards on iOS and Android.
🛠️ Advanced Chinese Tools Suite
- Animated Stroke Order (米字格 Mizige) — Step-by-step vector calligraphy animation modal with character tabs and playback speed controls.
- Text Difficulty & HSK Analyzer (
Alt + A) — Evaluates entire notes or selections, showing HSK 1–6 percentage distribution and CEFR difficulty ratings. - Zettelkasten Atomic Word Notes (
Alt + N) — 1-click generation of structured Markdown notes inChinese/Words/with YAML metadata, tags, readings, and context sentences. - Chengyu Origin Stories (成语故事) — Expandable ancient fables, allegorical meanings, and historical dynasty context for 4-character idioms.
- Printable Calligraphy Worksheets — Generate and print practice sheets with stroke tracing and blank Mizige grids directly to paper or PDF.
🚀 Quick Start
Installation via Community Directory (Recommended)
- In Obsidian, go to Settings > Community plugins.
- Make sure Restricted mode is turned off.
- Click Browse and search for
Chinese Popover Dictionary. - Click Install, then click Enable.
Manual Installation
- Download
main.js,manifest.json, andstyles.cssfrom the latest GitHub Release. - Create a folder named
chinese-popover-dictin your vault's plugins folder:<YourVault>/.obsidian/plugins/chinese-popover-dict/ - Place
main.js,manifest.json, andstyles.cssinto that folder. - Reload Obsidian and enable the plugin under Settings > Community plugins.
⌨️ Hotkeys & Commands
All actions can be bound to your favorite keyboard shortcuts under Settings > Hotkeys:
| Command | Suggested Shortcut | Description |
|---|---|---|
| Look up word under cursor or selection | Alt + D | Opens popover for active cursor position or selection |
| Star or unstar word | Alt + B | Adds or removes word from Personal Vocabulary notebook |
| Create Zettelkasten Word Note | Alt + N | Generates an atomic Markdown note with YAML in Chinese/Words/ |
| Analyze Text Difficulty & HSK | Alt + A | Analyzes HSK level distribution and CEFR difficulty |
| Open Calligraphy Worksheets | — | Opens printable Tianzige / Mizige practice sheets modal |
| Export Pleco Flashcards | — | Exports vocabulary as a .txt deck for Pleco mobile app |
| Speak Selected Text | Alt + R | Reads aloud selected sentences/paragraphs with neural TTS |
| Convert to Traditional (繁體) | — | Bidirectional conversion of selected text to traditional Hanzi |
| Convert to Simplified (简体) | — | Bidirectional conversion of selected text to simplified Hanzi |
| Open vocabulary in sidebar | — | Opens the vocabulary notebook panel in the right sidebar |
| Pronounce active word | Alt + P | Plays audio for current word in chosen dialect |
| Copy active word card | Alt + C | Copies formatted dictionary entry to clipboard |
| Switch Dialect | Alt + S | Toggles between Cantonese (廣東話) and Mandarin (普通话) |
| Cycle Phonetic Display | Alt + T | Cycles: Both → Pinyin → Jyutping → Auto |
| Toggle Chinese Dictionary | — | Enables or disables popover triggers |
| Close Popover | Escape | Closes any open popover immediately |
⚙️ Customization
Customize everything to match your vault's theme:
- Personal Vocabulary:
- Customizable markdown file path (
Chinese Vocabulary.md). - Auto-save context sentences: On / Off.
- Practice / flashcard mode toggle.
- Customizable markdown file path (
- Trigger Modes: Double-click, Hover with modifier key (Alt/Option, Shift, Ctrl, Cmd), Hover always, or Hotkeys only.
- Themes:
- 🌌 Liquid Glass Dark — Deep glassmorphism with vivid cyan/emerald highlights.
- ☀️ Liquid Glass Light — Frosted translucent glass tuned for light themes.
- ⬛ Solid Minimalist — Opaque card styling with zero transparency.
- 🔄 Auto — Adapts seamlessly to your current Obsidian theme.
- Card Dimensions: Adjust popover width (260–460 px), height (130–250 px), and backdrop blur (0–60 px).
- Typography: Fine-tune font sizes for Hanzi, Pinyin, and translations independently.
🔒 Privacy & Security
We believe your notes and thoughts belong solely to you:
- 🛡️ 100% Local Dictionary Queries: Words are looked up entirely inside your local vault. No note content, text selections, or keystrokes are ever sent to an external server.
- 📁 Your Data Stays Yours: Your personal vocabulary is written to standard Markdown in your vault. It will never be locked into proprietary formats and will remain readable forever.
- 🚫 Zero Telemetry: No trackers, no cookies, no analytics.
- 🌐 External Connections:
- Google TTS API (
translate.google.com): When the audio button is clicked, an audio stream is fetched for the selected word. You can switch to Web Speech API in settings for 100% offline pronunciation. - CEDICT Database Download: On first run, the plugin downloads the offline dictionary database (
cedict.json, ~42 MB) from GitHub Releases and caches it in your plugin folder for lifetime offline use.
- Google TTS API (
📺 Free Chinese Video Courses by Author
Learn Chinese for free with structured video courses created by the author of this plugin:
| Channel | Language | Description & Content | Link |
|---|---|---|---|
| Chinese with Kantulaev | 🇬🇧 English | Free comprehensive Chinese video courses from beginner to fluent: pronunciation, tones, character stroke order, and grammar. | @ChineseWithKantulaev |
| Курсы китайского языка | 🇷🇺 Русский | Бесплатные пошаговые видеоуроки китайского языка с нуля: фонетика, ключи Канси, разбор уровней HSK и живая разговорная речь. | @kantulaevCN |
📜 Credits & Licenses
- CC-CEDICT: Licensed under Creative Commons Attribution-Share Alike 3.0.
- Pleco Software: Hand-curated Cantonese readings database.
- CC-Canto: Additional colloquial Cantonese vocabulary.
- Rime Cantonese: Frequency and phonetic mappings.
📄 License
Distributed under the MIT License. Built with ❤️ for the Chinese learning community.