[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"project-105438":3},{"id":4,"name":5,"fullName":6,"owner":7,"repo":5,"description":8,"homepage":9,"htmlUrl":10,"language":11,"languages":10,"totalLinesOfCode":10,"stars":12,"forks":13,"watchers":14,"openIssues":15,"contributorsCount":15,"subscribersCount":15,"size":15,"stars1d":16,"stars7d":16,"stars30d":16,"stars90d":15,"forks30d":15,"starsTrendScore":17,"compositeScore":18,"rankGlobal":10,"rankLanguage":10,"license":19,"archived":20,"fork":20,"defaultBranch":21,"hasWiki":22,"hasPages":22,"topics":23,"createdAt":10,"pushedAt":10,"updatedAt":30,"readmeContent":31,"aiSummary":10,"trendingCount":15,"starSnapshotCount":15,"syncStatus":13,"lastSyncTime":32,"discoverSource":33},105438,"readme-visual-kit","tianfuzhibuyuci\u002Freadme-visual-kit","tianfuzhibuyuci","把带源码依据的项目说明变成三张 README 图：功能流程、简化架构、快速上手。本地 SVG 渲染器 + Agent Skill，无需 API Key。","https:\u002F\u002Ftianfuzhibuyuci.github.io\u002Freadme-visual-kit\u002F",null,"JavaScript",164,2,52,0,77,231,84.6,"MIT License",false,"main",true,[24,25,26,27,28,29],"agent-skills","developer-tools","diagrams","documentation","readme","svg","2026-11-01 00:16:44","# README Visual Kit\n\n**让别人不用安装，就先看懂你的项目。**\n\n把带源码依据的项目说明，变成三张统一风格的图：**功能流程、简化架构、快速上手**。本地 SVG 渲染器 + 可携带的 Agent Skill，无需 API Key、无第三方运行依赖。\n\n[English](README.en.md) · [在线体验](https:\u002F\u002Ftianfuzhibuyuci.github.io\u002Freadme-visual-kit\u002F) · [输入格式](references\u002Fmanifest.md)\n\n![README Visual Kit 中文演示预览](docs\u002Fpreview.png)\n\n\u003Cdetails>\n\u003Csummary>查看完整生成图\u003C\u002Fsummary>\n\n![中文功能图示例](docs\u002Fgallery\u002Fweb\u002Foverview.light.svg)\n\n\u003C\u002Fdetails>\n\n> v0.1.0 是可运行的本地 MVP，不是在线 AI 服务。三个示例都是为本项目编写的演示程序，不代表第三方用户或真实商业采用。\n\n## 30 秒试用\n\n下载或克隆本仓库，进入目录，准备 **Node.js 22+**：\n\n```sh\nnode scripts\u002Fcli.mjs render examples\u002Fcli\u002Fvisuals.json --root examples\u002Fcli --out demo\n```\n\n然后双击 `demo\u002Findex.html`。不需要 `npm install`、登录或密钥。若 `demo` 已存在，请换一个输出目录名；工具不会覆盖旧目录。\n\n也可以先[打开在线画廊](https:\u002F\u002Ftianfuzhibuyuci.github.io\u002Freadme-visual-kit\u002F)查看三个完整示例，无需安装。下载后双击 `docs\u002Fgallery\u002Findex.html` 也能查看；渲染器和生成的预览均支持离线使用。\n\n## 产出什么\n\n- **功能流程图**：输入 → 处理 → 输出。\n- **简化架构图**：关键组件及有向关系，不画不存在的数据库和服务。\n- **快速上手图**：从准备环境到第一次跑通。\n- 每张都有明暗两版 SVG，共六张；另含可编辑 JSON、README 嵌入片段、离线预览、来源报告。\n- 预览支持切换图表\u002F主题、下载和复制片段。手机端保持可读字号，横向滑动看图。\n\n## 和“AI 随便画张图”有什么不同\n\n**范围小、依据明确、可以修改。** 每个节点必须引用项目内真实文件和行号。渲染器检查文件和行范围是否存在，但**不证明描述或连线在语义上正确**；仍需要人或 Agent 审查。\n\n它不提供托管模型，不自动扫描整个仓库推断架构。你现有的 Agent 整理 JSON，本地脚本负责校验与绘图；使用已有模型仍可能产生模型费用。\n\n## 给自己的项目生成\n\n1. 让编码助手阅读本仓库根目录 `SKILL.md`，再读取目标项目 README 和相关源码；也可按照 [输入格式](references\u002Fmanifest.md) 自己写 JSON。\n2. 用 2–6 个节点讲清每张图，不确定的内容写 `uncertainty`，不要编造。\n3. 在目标项目目录里运行（脚本路径替换为你本机的实际路径）：\n\n   ```sh\n   node \u002Fpath\u002Fto\u002Freadme-visual-kit\u002Fscripts\u002Fcli.mjs check visuals.json --root .\n   node \u002Fpath\u002Fto\u002Freadme-visual-kit\u002Fscripts\u002Fcli.mjs render visuals.json --root . --out readme-visuals\n   ```\n\n4. 打开生成的 `index.html`，检查三张图、两套主题、架构箭头和命令。\n5. 复制 `README-snippet.md` 时，把图片路径前缀改为 `.\u002Freadme-visuals\u002F`。\n\n可直接给 Agent 的提示：\n\n> 按照 readme-visual-kit 中的 SKILL.md，为当前项目生成三张 README 图。仅依据 README 和相关源码，每个节点引用文件行号，不确定项明确标注。先校验，再输出到新的 readme-visuals 目录。不要执行项目命令，也不要发布到 GitHub。\n\n本仓库根目录就是一个完整 Skill。整体保留 `SKILL.md`、`scripts\u002F`、`references\u002F` 和引用到的示例，交给支持读取 Skill 的客户端；不同客户端的安装目录和自动发现方式各异。本工具不会修改你的全局配置。\n\n## 发布前必须注意\n\n`evidence.json` 和预览 HTML 包含引用的**源码片段**，可能含私有信息。发布前逐项审查；如果只想公开图，只上传六张 SVG 即可。不要把密钥写进输入 JSON。\n\n来源校验不是事实认证，也不会固定到 Git 提交；源码变化后应重新检查。输出目录必须不存在且其父目录已存在。磁盘错误可能留下部分新文件，处理原因后换一个新目录再生成。\n\n## 验收与限制\n\n- 三类可运行自建示例：Node CLI、中文浏览器应用、Python 工具库。\n- `npm test` 运行内置测试，无需安装依赖；测试覆盖校验、转义、路径安全、可编辑源保留和 CLI。\n- Windows／Ubuntu × Node.js 22／24 四组云端测试已通过；详细测试与视觉检查见 [QA 记录](docs\u002FQA.md)。\n- 架构只支持最多六节点的有向无环图；循环需先抽象，复杂图应换更专业的工具。\n- 手机预览可横向滑动；README 内 SVG 会按容器缩放，应尽量使用短标签。\n- 字体来自本机，中文会换行，但复杂文字和 emoji 仍需人工检查。\n- 不是拖拽画布，不提供 SVG 修改反向同步 JSON。\n\n欢迎提供可公开的真实项目示例、Bug 或带测试的改进。如果它帮你省下解释项目的时间，欢迎点一个 Star。不会要求先 Star 才能使用，也不承诺获得特定 Star 数。\n\nMIT 开源许可，见 [LICENSE](LICENSE)。\n","2026-10-31 04:26:48","CREATED_QUERY"]