Skip to content

JoreFocus/reading-trace

Repository files navigation

阅迹 Reading Trace

把文本结构、读者判断与理解变化,呈现为一个可交互的阅读界面。

阅迹不是摘要工具。它保留原文,让读者在关键位置标记“被击中、认同、部分认同、保留、反对”,写下原因,并导出一份属于自己的阅读轨迹。

当前版本使用梭罗《瓦尔登湖》第二章作为公版示例。

它解决什么

普通阅读页面只呈现文本,普通笔记只保存结果。阅迹尝试保存中间发生的事:

  • 哪些句子改变了阅读速度;
  • 读者在哪里接受、迟疑或反对;
  • 判断背后的理由是什么;
  • 阅读结束后,理解沿着什么路径发生变化。

功能

  • 数据驱动的章节、命题与结构角色;
  • 五档读者判断及即时进度统计;
  • 对低认同标记自动打开追问;
  • 按标记筛选,键盘移动和快捷标注;
  • 设备本地自动保存;
  • 一键复制紧凑的阅读标注结果;
  • 深浅色模式与完成后的收束分镜;
  • 桌面端与移动端响应式界面。

快速开始

需要 Node.js 22.13 或更高版本。

npm install
npm run dev

打开 http://localhost:3000

构建与验证:

npm test

换成自己的阅读材料

编辑 data/reading.json 即可,不需要修改页面代码。启动和构建前,项目会自动把数据同步到已经打磨好的交互模板。字段定义见 data/reading.schema.json,保存后可以先运行:

npm run validate:content

核心阅读位置结构:

{
  "id": "I-01",
  "role": "core",
  "quote": "原文",
  "context": "必要的上下文或结构说明",
  "prompt": "要求读者形成判断的问题"
}

界面显示 context 作为供读者判断的命题,roleLabels 作为命题旁的结构标签;quoteprompt 继续保留在数据层,便于 Agent 检查来源边界与提炼逻辑。界面不要求固定使用某种阅读理论;core / support / turn 的显示名称可以自行配置。

与 Codex / Claude Code 一起使用

仓库内置了两层 Agent 支持:

  • 根目录 AGENTS.mdCLAUDE.md:告诉 Agent 如何理解项目、替换内容和守住原文边界;
  • skills/build-reading-trace/:可选的阅迹构建 Skill,适合反复把文章、直播文稿、伴读记录或个人复盘做成交互式阅迹。

这里没有预设一份固定提示词。你可以用自己的方式向 Agent 描述目标;Agent 会从项目说明中读取内容契约与设计原则。

方法上的完整说明见 docs/creating-with-agents.md

直接在仓库里工作时不必安装 Skill,Codex 与 Claude Code 会先读取各自的项目入口。只有希望在支持 Skills 的 Agent 中反复调用这套流程时,才需要加载 skills/build-reading-trace/

设计方法

如果你不只想使用面板,还想打造自己的阅读界面,请阅读:

来源与致谢

阅迹诞生于我的 AI 伴读实践。伴读实践受到李继刚先生 ljg-read 的启发,在此致谢。

本项目聚焦阅读界面的呈现问题;界面设计、数据结构、渲染流程与面板设计方法为独立实现。更完整的说明见 ACKNOWLEDGEMENTS.md。 原作者对改编与公开再发布的明确授权记录见 lijigang/ljg-skills#27

《瓦尔登湖》示例原文取自 Project Gutenberg eBook #205,该来源页面将此版本标注为美国公版。

License

项目代码与原创文档采用 MIT License。第三方原文、名称及链接不因收录而改变其原有权利状态。

About

把文本结构、读者判断与理解变化,呈现为可交互的阅读界面。

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages