样例
样例都在 SDK 的 examples/ 里,每个都能通过 feyxo check。下面这张表是从样例自己的清单读出来的,一共 14 个:
| 文件夹 | 类型 | 名字 | 说明 |
|---|---|---|---|
examples/bundle-starter/ | 合集 bundle | 起步组合 | 一次装好夜墨外观和时间状语从句,先不练生词。 |
examples/cases-demo/ | 评测句集 cases | 长句主干示例 | 用十句自己写的长句,给“画整句结构”那一步打分。 |
examples/combo-light/ | 合集 bundle | 轻松读 | 一句少问几处、先认的词少一点、划一段只问一次,不改你的节奏包,退回就恢复。 |
examples/export-markdown/ | 导出模板 export | Markdown 笔记 | 把做题记录导出成一条一句的 Markdown 笔记,贴进笔记软件就能用。 |
examples/language-demo/ | 界面语言 language | 示例语言(加括号) | 把界面上的每一句套上〔〕,看得出换语言以后哪些字跟着换了。 |
examples/look-night/ | 外观 look | 夜墨 | 把深色网站上的蓝、琥珀调亮一点,卡片更黑,线索用点线标出来。 |
examples/look-paper/ | 外观 look | 米纸 | 页面和卡片换成米黄的纸,总是浅色,字大一点、行松一点,划掉的修饰画一条线,命门带一圈柔光。 |
examples/pace-gentle/ | 节奏 pace | 慢一点 | 让你多试几次再给提示,做完多停几秒再往下走,一句少问几处。 |
examples/prompt-junior/ | 提示词 prompt | 初中版说明 | 只换提示词里的几小节,不用整篇抄:把“找会卡住的地方”那一步的受众改成初中生,换一行发给模型的话(例子里的表头跟着换),再换一个字段的说明。 |
examples/prompt-small/ | 提示词 prompt | 小模型说明 | 把“这个词他认不认识”那一步的说明写短,给本地跑的小模型用。 |
examples/site-demo/ | 网站适配 site | 示例网站适配 | 告诉扉阅示例新闻站的正文在哪,评论区和推荐阅读别管。 |
examples/time-clauses/ | 语法 grammar | 时间状语从句 | 把 before、after、until 连着的两件事练成一眼看出谁先谁后。 |
examples/voice-kaoyan/ | 讲法 voice | 考研版讲法 | 把时态、被动的说法换成考研语法书里的术语,方便对着书复习。 |
examples/welcome-junior/ | welcome | 初中版欢迎页 | 先练一句带修饰的简单句(一个主谓、没有从句),再配模型、开启要读的网站、打开扉阅。 |
逐个讲
小节标题“逐个讲”time-clauses(语法):最值得先看的一个。一个语法点 which-first,用“拖进格子”把 before / after / until 连着的两件事放上时间线(先发生 / 后发生)。有完整的 point.json、rules.json(4 张规则卡)、detect.md、practice.md 和 12 句 cases.jsonl。想做语法包,从它改起。
look-night(外观):夜墨。只改了几个颜色(深色网站上的蓝、琥珀调亮,卡片更黑)、字体里的英文衬线,和两种样子(clue 线索改成点线、segment-placed 放对)。演示“没写的项用自带的补上”:一个外观包可以很短。
voice-kaoyan(讲法):把时态、被动的规则卡说法换成语法书里的术语,方便对着书复习。演示 rules、points、texts、explain 四块怎么写。(名字里的“考研”只是这个样例的用途,扉阅自带的组合没有考研一套。)
language-demo(界面语言,生成的):把每一句界面文字套上〔〕的伪翻译,用来一眼看出换了语言以后,哪些字跟着换了、哪些还没收进来。不用手改,用 feyxo examples 重新生成。
pace-gentle(节奏):慢一点。只写了 8 个数:多试几次再给提示、做完多停几秒再往下走、一句少问几处。演示“只写你要改的”。
prompt-small(提示词):给 7B 左右的本地模型写的、更短的“这个词认不认识”(word-tier)那一步说明。演示 prompt.json 的 for 和 prompts/<任务名>.md。
cases-demo(评测句集):10 句自己写的长句,给“画整句结构”(structure)那一步当标准答案(每句写了主干)。演示 cases.json 的 for、source(必须写)和 cases.jsonl。
export-markdown(导出模板):把做题记录导出成 Markdown 笔记:每条一个列表项,下面带日期、网站、哪一类、做得怎样、备注。演示占位的用法。
site-demo(网站适配):告诉扉阅一个示例新闻站的正文在哪(article .story-body),评论区、推荐阅读、订阅栏别管。
bundle-starter(合集,生成的):一次装好夜墨外观和时间状语从句,先不练生词。里面把 look-night、time-clauses 两个样例原样打了进来,演示 needs 和 plugins/<作者>/<名字>.json。
怎么用
小节标题“怎么用”- 复制一个样例文件夹。
- 改清单里的
id、name、description、author、license。样例都是AGPL-3.0-only,改了再发给别人要用同样的许可证公开;从头自己写的,许可证自己选。id 里不能含 feyxo,名字、作者里不能含“扉阅”或 feyxo。 feyxo check查,feyxo pack打包。
见做第一个扩展包。