Qwerty Learner自定义词典导入教程:4步把你自己的词表送上打字练习页
【免费下载链接】qwerty-learner为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers项目地址: https://gitcode.com/GitHub_Trending/qw/qwerty-learner
你手上有一份自己整理的单词表,想用它来练打字,但Qwerty Learner——这款做单词记忆和英语肌肉记忆训练的打字软件——默认只提供内置词库。这篇教程带你从一份原始词表出发,4步把自定义词典放进软件并真正跑起来。
动手前自查:4个硬性条件
先花30秒确认以下事项,能避开后面大部分返工:
- 格式:词库是一个 JSON 文件,顶层为数组,每个词条至少含
name(单词)和trans(释义数组)两个字段 - 位置:文件必须放在
public/dicts/目录下 - 注册:软件不自动扫描目录,词典必须在
src/resources/dictionary.ts里登记一条记录才会出现在列表中 - 编码:文件保存为 UTF-8,否则中文释义会乱码
- 依赖:本地需要 Node.js 环境,项目用
yarn管理依赖
主流程:从词表到练习页的4个步骤
第1步:获取项目并安装依赖
在任意目录执行:
git clone https://gitcode.com/GitHub_Trending/qw/qwerty-learner && cd qwerty-learner && yarn做完后应该看到:node_modules/目录已生成,终端无报错输出。
第2步:创建你的词典文件
在public/dicts/下新建文件,比如MyWords.json。内容长这样:
[ { "name": "example", "trans": ["n. 例子,示例"] }, { "name": "keyboard", "trans": ["n. 键盘", "n. 打字机"] } ]要点:trans必须是数组,一个单词有多个释义就放多个元素;usphone、ukphone音标字段可选,不提供则该词不显示音标。
做完后应该看到:文件可被任意 JSON 编辑器/校验器正常解析。
第3步:在索引文件中登记词典
打开src/resources/dictionary.ts,找到你目标分类对应的数组(如chinaExam、internationalExam),追加一条记录:
{ "id": "my-words", "name": "我的专属词表", "description": "个人整理的练词清单", "category": "中国考试", "tags": ["大学英语"], "url": "/dicts/MyWords.json", "length": 120, "language": "en", "languageCategory": "en" }各字段的作用:
id:全局唯一,重复会导致行为异常name/description:展示给用户看的词典名和描述category:决定词典在目录页归入哪个分组,可先浏览该文件里已有的分类选一个url:指向第2步的文件,必须以/dicts/开头length:词条总数,后面会用脚本自动修正language/languageCategory:词典的语言,决定练习页的发音和显示方式
第4步:启动开发服务器并验证
运行yarn dev,浏览器打开http://localhost:5173。
做完后应该看到:词典目录页出现"我的专属词表",词量显示与文件一致;点进去能开始打字练习,每打对一个词都有即时反馈。
两种典型词库的字段差异
流程相同,但不同用途的词典在注册字段上有讲究。
场景一:英语考试词汇(考研、四六级等)
按第3步默认字段填写即可:language: 'en'、languageCategory: 'en',category选"中国考试"或"国际考试"。词条里建议带上usphone/ukphone,这样练习时能开发音开关跟读。
场景二:编程术语、代码关键字
这类词库走 code 通道,两个字段要改成:
"language": "code", "languageCategory": "code"此时练习页按代码模式处理词条,不走英语发音逻辑。项目里go_keyword.json、python-builtin.json等都是这类,可参考public/dicts/下的现成文件抄结构。
顺带一提:language还支持ja、de、id等取值,做日语、德语词库时按需对应即可,其余步骤不变。
避坑区:3个最容易卡住的地方
词典注册了但列表里不出现
- 现象:
yarn dev正常启动,目录页却找不到新词典 - 原因:
url写成了dicts/xxx.json(漏了开头的/),或id与已有词典重复被覆盖 - 解法:对照文件里相邻条目逐字段核对,
url必须以/dicts/开头
词库能选但列表空白或报错
- 现象:点进词典后加载失败,或词条没有释义
- 原因:JSON 语法错误(数组末尾多写逗号、释义里含未转义的引号),导致整个文件解析失败
- 解法:把文件内容粘进 JSON 校验器定位具体行;同时确认
trans是字符串数组而不是单个字符串
词量数字对不上
- 现象:页面上显示的词条数和你实际的条数不一致
- 原因:
length是手填的,改过词表后忘了更新 - 解法:运行
node scripts/update-dict-size.js,脚本会扫描public/dicts/并自动把正确的数量写回src/resources/dictionary.ts
下一步:换成你真正的词表
- 把第2步示例里的
example、keyboard替换成你实际要练的词,重跑第4步确认加载正常 - 再做一本不同分类的词库(比如一本"考研"、一本"编程"),对比目录页的分组效果
- 想从 CSV、Excel 等词源批量转换格式,或走社区贡献流程把词典提交给官方,完整说明见 docs/toBuildDict.md
【免费下载链接】qwerty-learner为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers项目地址: https://gitcode.com/GitHub_Trending/qw/qwerty-learner
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考