▥   README VISUAL KIT
v0.1 · 本地运行 · English
为值得被理解的项目而做

你的 README,
用三张图讲清楚。

功能怎么运转、组件如何协作、第一步怎么开始。
三种图表,可编辑 SVG,无需 API Key。

01 / 只有文字时

口袋笔记允许用户在文本框中输入笔记,点击保存后写入当前来源的浏览器本地存储。重新打开同一来源的页面时,可以恢复之前保存的内容。

不联网同步,不提供账户,不加密。更换浏览器或端口不会同步笔记;请勿输入敏感信息。

描述没错,但一张图更方便看清流程。→
02 / 配上图表 · 可滚动查看
口袋笔记功能流程:输入笔记、点击保存、重新打开后恢复
示例虽小,产出完整

一套流程,三类项目。

三个示例均为本项目自建的可运行演示,不代表外部用户采用。
每个示例都包含三种图表、明暗主题与源码引用。

一条命令,生成十个文件。

下载仓库后进入目录,准备 Node.js 22+,无需 npm install。

node scripts/cli.mjs render examples/cli/visuals.json --root examples/cli --out demo

打开 demo/index.html,即可查看 SVG、编辑 JSON 输入,或复制 README 嵌入片段。

有源码依据,不凭空编造

节点引用真实文件与行号。校验器检查引用是否存在;描述与连线是否正确,仍需人工审核。

你的智能助手负责整理

附带的 Skill 指导你已有的智能助手整理输入。本地渲染器负责绘图,不调用 AI 接口。

源码是否公开,由你决定

发布前请检查源码摘录。可以只公开 SVG,把含源码片段的依据文件留在本地。