Skip to content

Shareable Reading Notes

Pre-release
Pre-release

Choose a tag to compare

View all tags
@zlsjtj zlsjtj released this 04 Oct 17:41
· 1 commit to master since this release
v0.1.0-preview.4
161df79

给关键代码起一个标题，把阅读路线导出成一篇更好读的源码笔记。 这版完善了 Reading Routes 的整理与分享，并提供 Click 和 CodeAtlas 自身的两个完整案例。阅读、记笔记和导出仍不需要模型 Key。

CodeAtlas：带位置标题的 Click 阅读路线，以及搜索、保存和导出过程

约 14 秒真实操作剪辑，部分 2 倍速，无模型调用。40 秒完整实录

从 preview.3 更新了什么

  • 每个阅读位置可以有自己的标题。 用“创建命令”“排序并返回结果”说明为什么保存这段代码；原来的路线仍可读取，不必重新整理。
  • 导出笔记更适合直接阅读。 标题、源码链接、笔记和带语言标记的代码块组成正文，保存时间与文件哈希收进“来源与版本”折叠区。
  • 两个可跟读的完整案例。 Click 用三个位置解释装饰器与回调；CodeAtlas 用六个位置串起 React、FastAPI、索引查询和结果展示。

Click 导出笔记 · CodeAtlas 搜索案例 · CodeAtlas 导出笔记

直接试一次

准备 Python 3.11+、Node.js 20.12+ 和 Git：

git clone --branch v0.1.0-preview.4 https://github.com/zlsjtj/CodeAtlas.git
cd CodeAtlas
npm run setup
npm run demo

打开终端打印的地址，Click 已导入并索引。搜索 callback=f，打开源码，保存一个位置并添加标题、笔记，再到“路线”中导出 Markdown。示例数据独立保存，不覆盖 .env，也不使用其中的模型 Key。退出按 Ctrl+C。

读自己的仓库用 npm run dev。已有 checkout 更新前先保存本地改动；此版本兼容旧路线，没有数据库迁移。路线保存在当前浏览器，更新或清理浏览器数据前建议先导出笔记。Docker 和配置见本版本 README。

素材来自真实工作台，导出文件未手工改写。源码摘录和版本核对结果见实录记录与跨前后端案例记录。

English

Give each reading stop a title, then share a clearer source-code walkthrough. This release improves Reading Routes and its Markdown output, with two complete examples to follow. Reading, annotation, and export need no model key.

  • Name individual stops while keeping existing saved routes compatible.
  • Export titled sections, source links, notes, and language-tagged code blocks. Timestamps and file hashes fold into “Source and version.”
  • Follow Click from decorator to callback, or trace CodeAtlas's search across React, FastAPI, and its index query.

Click export · CodeAtlas walkthrough · CodeAtlas export

Run the commands above, open the printed URL, and switch to English. Search callback=f in the preloaded Click repository, save a stop with a title and note, then export it from Route. Use npm run dev for your own repositories. Save local changes before updating an existing checkout; this release needs no database migration and keeps older routes readable. Export notes before clearing browser data. See the versioned README for Docker and configuration.

English short demo: about 14 seconds of real actions, edited with some sections at 2× speed. Full 40-second recording. Neither uses model calls.

服务仅供本机使用，检查只应在信任的仓库运行。分享笔记前移除私有代码和凭据；模型问答需另行配置，其验证状态见运行说明。

Keep the service local, run checks only on trusted repositories, and review exports before sharing private code. Optional model setup and validation status are documented in the execution notes.

Changes since preview.3 · Previous release · Report a problem or share feedback

发布提交 / Release commit: 161df79. Windows, Ubuntu, and Linux Docker CI: passed.

Assets 2
Loading