Agent Skills
返回列表
源码书籍生成器

源码书籍生成器

内容创作 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_746e0cc6/codebook。

技能介绍

问题在哪

接手陌生仓库时,README 往往只覆盖安装与用法,模块边界、调用链路和关键实现散落在大量文件里。你需要一份可检索、可点进源码行号的中文导读,但又不想搭静态站、引 CDN,或把读者绑在 GitHub 网页上翻文件树。

技能如何工作

Codebook 按三阶段流水线执行:获取源码 → 分析代码 → 生成 HTML。

  • 获取:区分本地目录与远程 Git URL;远程仓库优先浅克隆,并记录 origin 与 HEAD 提交哈希,供后续「在仓库中打开」链接钉死版本。
  • 分析:读 README、依赖清单与入口;用目录梳理与追踪把核心功能从 CLI、路由或 main 一路追到实现,每个引用必须对应真实文件与行号,禁止臆造。
  • 生成:以 assets/template.html 为骨架,填入入门指南、架构说明与核心功能详解;代码块用可折叠 .snippet 内嵌源码,架构可用内联 SVG,最终输出单个 *-codebook.html,离线可开、内置全文搜索与面包屑。

边界与注意点

  • 产出是中文 HTML 书籍式文档,不是改仓库、不是自动修 bug。
  • 分析质量依赖仓库结构与 SKILL 引用的 references/code-analysis-guide.md;超大单体仓库可能需要你收窄分析范围。
  • 仅当远程克隆成功时,片段头部才会带基于 commit 的仓库跳转链接。

使用场景

  • 新人入职一周内要把某个 GitHub 服务端仓库梳成带调用链的中文导读,方便内部分享
  • 技术分享前需把本地 monorepo 某子模块从入口到核心实现写成可搜索的单文件 HTML
  • 架构评审材料要求附可折叠源码片段与行号,且评审现场无法访问外网
  • Maintainer 收到 Gitee 仓库 URL,希望产出 DeepWiki 风格中文书籍文档供合伙人离线阅读

适合人员

  • 负责带新人读库的资深工程师,要把指定仓库整理成可检索、带行号跳转的中文技术书
  • 写开源项目 Wiki 的维护者,希望从 README 不足以说明的实现细节里抽出结构化章节
  • 需要做源码级技术评审的架构师,要求文档自包含且能在内网环境直接双击打开
  • 接到「讲解这个仓库怎么跑起来、核心链路在哪」任务的技术讲师或内训负责人