lucubratio-public
Discovered★ 3Lucubratio Pipeline + Viewer: Compile any course content into an offline-learnable content package, without including any course materials. The name comes from the Latin phrase meaning "nighttime work, studying by lamplight"—which is precisely the original meaning of "self-study."
仓库已开放(Apache-2.0):https://github.com/Albusriddle/lucubratio-public 你可以直接 clone 使用;Releases 页提供签名过的查看器 APK(包名
com.lucubratio.reader.public,可与其它版本共存)。 本仓库不含任何课程素材——课程内容由使用者自己生成并导入。
Lucubratio · 流水线 + 查看器
Lucubratio 是拉丁语「夜间工作、挑灯夜读」——正是「自习」这件事的本义。
把任意课程内容编译成可离线学习的内容包,再用一个只读查看器读它、记进度、按 FSRS 复习。
本仓库只提供流水线与查看器,不含任何课程素材。示例页(
content/os/01、02)是自撰的格式demo。
这是什么
三件东西,彼此解耦:
| 部分 | 位置 | 作用 |
|---|---|---|
| 内容规范 | docs/CONTENT-SPEC.md | 一页内容该怎么写:标题/锚点、公式、Mermaid 图、表格、自评单元、图片 |
| 编译器 | scripts/build.mjs | 源 HTML → 可运行站点:注入壳层、公式转 MathML、给命中规则的标题打自评标记、生成检索索引与 manifest |
| 查看器 | web/ + android/ | 底栏三 tab(主页/目录/我的)、三级目录、离线阅读、断点续读、自评 → FSRS 复习、解析默认折叠、全文搜索、学习统计、课件页截图内嵌、PPT 原版截图侧栏(可拖动悬浮球入口,整本按页序翻阅 + 跳页 + 返回键逐层关闭)、文件管理器里点开 .lcr 直接导入(确认框显示标题/页数/体积;也可「分享到 Lucubratio」)、批量导入(多选分享 / App 内多选,一个确认框列全部包)、开屏只在冷启动(回首页走页面切换的幕布转场)、目录页可删除已导入课程、页面切换过渡(淡出→黑→淡入)与弹窗动画、环境自检(diagnostics) |
生成侧还有一套规范:AGENTS.md(硬约束与红线)+ docs/AGENTS-SPEC.md(角色分工、逐页模板、复核流程)—— 规定了"双人独立产出 + 第三人复核",用来保证 AI 生成的内容不出事实错误。
快速开始
三条路(只读课程 / 改界面 / 做成自己的 App)见
docs/QUICKSTART.md。
# 1) 编译(零依赖,只需 Node 20+)
node scripts/build.mjs
# 2) 校验产物(锚点/图片/公式基线/自评单元数/DOM id/仓库卫生)
node scripts/verify.mjs
# 3) 测试
npm test # 纯函数单测
npm run test:package # 打包器 + 校验器正负自测
npm run test:library # 课程库合并逻辑(内置 + 已导入)
npm run check:changelog # CHANGELOG 结构守则
npm run check:gates # 复核门禁(红线 3):检查 reviews 目录里的门禁记录是否全部通过
npm run check:nav # 导航守则:除 shell/boot.js 外禁止裸 location 跳转(CI 与 test:all 都跑)
npm run test:all # 全量 13 步(= 上面这些 + 构建/校验/片段预检/题目自检/空构建冒烟/多段合并/导航守则)
# 4) 真机检查(需设备;两者不同,按需跑)
npm run smoke # 数据层冒烟:进度/复习/备份/检索索引是否正常
npm run verify:device # 页面体检:内置课程能开、不存在的路径返 404 而不回落网络
npm run check:pages # 逐页体检:壳页各开一遍抓 JS 异常 + 两条行为断言
# (抽屉章标题吸顶 gap≤1px;同会话回首页不再显示开屏)
# 5)(可选)出一个"没有内置内容"的包:课程全靠导入
npm run build:empty
SKIP_WEB_BUILD=1 npm run build:debug # 必须跳过 preBuild,否则会被常规构建覆盖
# 6) 打成课程包(.lcr,可校验后分发)
npm run pack -- --id demo --title "示例课程" --version 0.1.0
npm run verify:package -- dist/demo-0.1.0.lcr
# 7) 出常规 APK(需要 JDK 17 + Android SDK 35)
npm run build:debug
产物在 android/app/src/main/assets/web/,这是构建输出、不入库。
目录结构
content/os/ # 课程内容(源):本仓库只有 2 页 demo,请替换成你自己的
web/ # 查看器:index / toc / me 三个壳页 + shell/ 脚本样式 + vendor/ 内置库
web/img/ # 课件页截图(本地渲染,gitignored,不进仓库)
scripts/ # 编译器 / 校验器 / 单测 / 冒烟 / 打包 / gradle 入口 / chronology 守则(check-changelog)
tools/ # 生成侧工具(抽取 / 写作 / 合稿 / 质量检查),见 tools/README.md
android/ # Android WebView 壳(无网络权限,纯本地)
docs/ # 内容规范 · 生成规范 · 课程包格式 · 导入 · 排障 · 路线图 · 真机验收清单
docs/skill/ # DSH 生成技能镜像(SKILL / prompts / 模板 / 踩坑)
.github/workflows/ # CI 与 Release
AGENTS.md # 硬约束(红线):课程内容与课程包不得进 git / 不得上传
NOTICE # 版权与第三方组件声明
设计约束(有意为之)
- 完全离线:APK 不声明
INTERNET权限。 - 不用
file://:所有页面走WebViewAssetLoader的https://appassets.androidplatform.net,否则 IndexedDB 不可持久。 - 内容与壳分离:
content/是内容源,android/.../assets/web/只是产物;改内容永远改源文件。 - 图只用 Mermaid:字符画在手机上必然错位(中文不是等宽两倍)。
你自己接课程
- 读
docs/CONTENT-SPEC.md,按格式写content/os/NN_标题.html; - 在
scripts/build.mjs的QUESTION_RULES里为你的页面加一条自评规则; - 跑
node scripts/build.mjs && node scripts/verify.mjs; - 出 APK 自己装。
已经支持「课程包
.lcr+ App 内导入」:教程见docs/IMPORT.md, 格式见docs/PACKAGE-FORMAT.md,进度见docs/ROADMAP.md; 版本变更见CHANGELOG.md。
许可
本仓库以 Apache License 2.0 发布,全文见 LICENSE。要点:
- ✅ 可以自由使用、修改、分发(含商业使用)
- ✅ 附带专利授权(贡献者不会因专利反诉你)
- ✅ 改了什么不必开源,但需保留版权与许可声明、并在修改过的文件里注明
- ⚠️ 课程内容不在本许可范围内:
content/里你自己生成的课程,版权归你;若内容来自他人讲义/教材,公开分发前请自行取得授权 - 商标与项目名(Lucubratio)不在授权范围内
若你 fork 后对外分发,建议保留
NOTICE(如有)与本 LICENSE 文件。
免责
本仓库不提供任何课件、教材、讲义截图。使用者把课堂材料转成内容时,版权与合规责任自负——此类转换通常只适合个人学习,不宜公开分发。
Comments
Loading…
Similar plugins
阅读代码 · DSH 独立插件:一个独立于普通工作区选择的代码阅读模式:先理解业务,再梳理调用链、精读实现,最后通过具体场景验证理解。
★ 0
MIT
JavaScript
dsh plugin --profile web add dsh-code-readingby Paimonshen
Coding-learn floating panel: edits and runs Python/JavaScript/TypeScript/PowerShell with exit code and timing, grades JSON course lessons with progress export, keeps Markdown notes and snippet library
★ 4
↓ 248/wk
MIT
JavaScript
Oct 4, 2026
dsh plugin --profile web add dsh-coding-pluginby SAOS-3624
陪看:让只会读文字的模型跟着你的真实播放进度一段段看视频(DSH 插件)。A DSH plugin that watches a video together with a text-only agent — one segment at a time, lines spoken at the right second.
★ 48
↓ 5.8k/wk
Apache-2.0
JavaScript
Nov 16, 2026
dsh plugin --profile agent add dsh-watch-togetherby Ame-Choo
DSH 学习教练插件:把一门课拆成知识地图,逐单元记掌握度、排每日任务,并给学生一个看得见进度的网页面板。
★ 4
↓ 172/wk
MIT
JavaScript
Oct 14, 2026
dsh plugin --profile web add dsh-study-coachby Sakayorilove
Laurel 套件:给 DeepSeek Harness 的控制中心与八个可单独开关的模块(通知 / 记忆核心 / 上下文压缩 / 自动继续 / 内耗护栏 / 深度科研 / 思考滚动窗 / 可视化规划)
★ 0
MIT
JavaScript
Nov 6, 2026
dsh plugin --profile web add laurel-centerby Kirisame1969
DeepSeek Harness (DSH) 项目制教学教练:学科无关的教学引擎 + 可替换领域包(Unity/C#)。A project-based learning coach shipped as a DSH skill and plugin bundle.
★ 2
MIT
JavaScript
Sep 27, 2026
dsh plugin --profile web add dsh-project-based-learning