README file from
GithubFleurDict
一款优雅的 Obsidian 英语词典插件,提供划词查询、AI 智能解析、生词本管理和间隔重复复习等完整学习体验。
An elegant English dictionary plugin for Obsidian, providing word lookup, AI-powered explanations, vocabulary notebook, and spaced repetition review.
中文文档
核心功能
智能词典查询
- 划词即查:双击单词或划选短语,自动弹出词典释义
- 多源聚合:支持有道词典、Free Dictionary API、本地 JSON 词典、MDX 格式词典
- 离线支持:可导入本地词典文件,无网络也能查词
- 智能缓存:自动缓存查询结果,减少重复请求
PDF 阅读支持
- PDF 双击查词:在 Obsidian 内置 PDF 阅读器中双击单词即可查询,与笔记内体验一致
- PDF 右键菜单:选中文本后右键即可「查词 / 加入生词本 / AI 翻译 / AI 详解」
- 生词高亮驻留:PDF 中的生词按熟练度分级着色,翻页、滚动、缩放都不会丢失
- 连字还原:自动处理 PDF 常见的软连字符与跨行断词(
exam-+ple→example) - 两套独立配色:PDF 高亮采用独立配色方案,不会与笔记内高亮互相干扰
AI 智能解析
- AI 详解:一键获取单词的详细讲解,包括词源、记忆技巧、用法示例
- AI 翻译:智能翻译选中的文本或整个句子
- 多模型支持:支持 DeepSeek、Qwen、GLM、SiliconFlow 等主流 AI 服务
- 流式输出:实时显示 AI 回复,无需等待完整响应
生词本管理
- 自动收录:查询过的单词可一键加入生词本
- 词性标注:名词、动词、形容词等词性标签可视化渲染
- 上下文记录:自动保存单词出现的语境
- 欧路同步:支持与欧路词典双向同步
间隔重复复习
- SM-2 算法:基于科学的间隔重复算法,优化记忆效果
- 闪卡模式:支持到期复习、分类复习、随机复习
- 进度追踪:记录每个单词的复习次数和掌握程度
- 每日统计:显示今日待复习单词数量
优雅界面
- Light/Dark 主题:完美适配 Obsidian 浅色和深色主题
- 响应式设计:支持桌面端和移动端
- 可拖拽弹窗:词典弹窗可自由拖拽和调整大小
数据安全与多设备
- 密钥默认存入系统钥匙串:AI API Key 与欧路 Token 保存在系统钥匙串(macOS 钥匙串 / Windows 凭据管理器),不会以明文写入
data.json - 可切换保存位置:设置 > 密钥存储 可在“系统钥匙串”与“data.json”之间随时切换,切换时密钥自动搬运,无需重新填写
- 系统钥匙串(默认,推荐):密钥不会离开本机,也不会随 Obsidian Sync / iCloud / OneDrive 扩散。代价是密钥不随 vault 同步,每台设备需要各自填写一次
- data.json:密钥随 vault 同步,多设备共用一份。代价是以明文保存在仓库中,并会随同步上传到云端
- 默认不输出日志:插件不会把查词内容、生词本词条或选中文本打印到控制台
安装方式
通过社区插件安装(推荐)
- 打开 Obsidian 设置 > 第三方插件
- 搜索 "FleurDict"
- 点击安装并启用
通过 BRAT 安装
- 在 Obsidian 中安装 BRAT 插件
- 打开 BRAT 设置,点击 "Add Beta Plugin"
- 输入仓库地址:
gibsonchan5/fleurdict - 点击 "Add Plugin" 完成安装
手动安装
- 从 Releases 下载最新版本
- 解压后将文件夹放入 Obsidian vault 的
.obsidian/plugins/目录 - 在 Obsidian 设置中启用 FleurDict 插件
快速开始
1. 配置 AI 服务(可选)
- 打开设置 > FleurDict > AI 设置
- 选择 AI 提供商(推荐 DeepSeek)
- 填入 API Key
- 保存设置
2. 开始使用
- 划词查词:在编辑器中双击单词或划选短语
- PDF 查词:直接在 PDF 阅读器中双击单词或划选短语,操作方式与笔记内完全一致
- 右键菜单:右键点击选中的文本,选择“查词”、“AI 详解”、“加入生词本”
- 侧栏视图:点击左侧 ribbon 图标打开生词本或 AI 侧栏
English Documentation
Features
Smart Dictionary Lookup
- Click to look up: Double-click a word or select a phrase to get instant definitions
- Multi-source: Supports Youdao, Eudic, Free Dictionary API, and more
- Smart caching: Automatic caching to reduce redundant API calls
PDF Reading Support
- PDF lookup: Double-click a word inside Obsidian's built-in PDF viewer for the same experience as in notes
- PDF context menu: Right-click a selection for "Look up / Add to Vocabulary / AI Translate / AI Explanation"
- Persistent highlights: Vocabulary words in PDFs are colour-coded by proficiency and survive page turns, scrolling, and zooming
- Dehyphenation: Handles PDF soft hyphens and words broken across lines (
exam-+ple→example) - Separate palette: PDF highlights use their own colour scheme, so they never clash with in-note highlights
AI-Powered Analysis
- AI Explanation: One-click detailed explanation including etymology, memory tips, and usage examples
- AI Translation: Smart translation for selected text or full sentences
- Multi-model support: Works with DeepSeek and other mainstream AI providers
- Streaming output: Real-time display of AI responses
Vocabulary Notebook
- Auto collection: Add looked-up words to your notebook with one click
- POS tags: Part-of-speech labels rendered as visual tags
- Context saving: Automatically records the context where the word appeared
- Eudic sync: Bidirectional sync with Eudic dictionary
Spaced Repetition Review
- SM-2 algorithm: Scientific spaced repetition for optimal memorization
- Flashcard mode: Due-only, category-based, or random review
- Progress tracking: Records review count and mastery level for each word
Elegant Interface
- Light/Dark theme: Seamlessly adapts to Obsidian light and dark themes
- Responsive design: Works on desktop and mobile
- Draggable popup: Freely draggable and resizable dictionary popup
Privacy & Security
- Keys in the keychain by default: Your API key and Eudic token are stored in the system keychain (macOS Keychain / Windows Credential Manager) and are never written to
data.jsonin plain text - Choose where keys live: Settings → 密钥存储 switches between the keychain and
data.jsonon the fly, carrying the existing keys over. The keychain never leaves your machine, so each device needs its own paste;data.jsonsyncs with the vault across devices but keeps keys in clear text - No logs by default: The plugin prints no user content (looked-up words, notebook entries, selected text) to the console
- Controllable highlights: In-note vocabulary highlighting can be toggled on or off at any time in the settings
Installation
From Community Plugins (Recommended)
- Open Obsidian Settings > Community Plugins
- Search for "FleurDict"
- Click Install and Enable
Via BRAT
- Install the BRAT plugin
- Open BRAT settings, click "Add Beta Plugin"
- Enter repository:
gibsonchan5/fleurdict
Manual Installation
- Download the latest release from Releases
- Extract and copy the folder to
.obsidian/plugins/ - Enable in Obsidian Settings > Community Plugins
Quick Start
1. Configure AI Service (Optional)
Open Settings > FleurDict > AI Settings, enter your DeepSeek API Key to enable AI explanations and translations.
2. Start Using
- Look up words: Double-click a word or select a phrase in the editor
- PDF lookup: Double-click a word or select a phrase directly inside the PDF viewer
- Right-click menu: Right-click selected text for "Look up", "AI Explanation", "Add to Vocabulary"
- Sidebar: Click the ribbon icon on the left to open the Vocabulary Notebook or AI sidebar
致谢 / Credits
- 有道词典 - 英汉/汉英词典查询数据源
- Free Dictionary API - 英文释义数据源
- 欧路词典 - 生词本同步支持
- Obsidian - 优秀的笔记应用
- SM-2 算法 - 间隔重复算法
许可证 / License
MIT License
数据来源与免责声明 / Data Sources & Disclaimer
数据来源 / Data Sources
本插件使用的词典数据来源:
- 有道词典:提供英汉/汉英词典查询服务,数据来源于网易有道词典网页版接口
- Free Dictionary API:提供英文释义,数据来源于 Wiktionary(CC BY-SA 4.0 许可证)
- 欧路词典 API:用于生词本同步,用户需自行提供授权 Token
Dictionary data sources used by this plugin:
- Youdao Dictionary: Provides English-Chinese/Chinese-English dictionary lookup, data sourced from NetEase Youdao Dictionary web API
- Free Dictionary API: Provides English definitions, data sourced from Wiktionary (CC BY-SA 4.0 license)
- Eudic API: Used for vocabulary notebook sync, users must provide their own authorization token
免责声明 / Disclaimer
-
本插件仅供个人学习使用,不得用于商业用途
-
词典数据版权归原作者或机构所有,插件开发者不拥有相关数据权利
-
如相关数据提供方认为本插件侵犯其权益,请联系开发者处理
-
使用本插件即表示您同意遵守各数据提供方的服务条款
-
This plugin is for personal learning use only and may not be used for commercial purposes
-
Dictionary data is owned by its respective authors/organizations; the plugin developer does not own the rights to this data
-
If any data provider believes this plugin infringes on their rights, please contact the developer
-
By using this plugin, you agree to comply with the terms of service of each data provider
联系方式 / Contact
- GitHub: @gibsonchan5
- Issues: 提交问题 / Report a bug
Made with heart for Obsidian community