SuperAPI AI 工具集

lovstudio-repo2docs

设计与创作

查看项目

更新于 10-16 00:01

技能介绍

用途:把任意文件夹(代码仓库、文章集合或含图片的混合知识库)统一整理为专业的 Fumadocs 文档网站,并可部署到 https://{product-id}.lovstudio.ai/docs。代码与文章被视为同一种源材料,区别只在于每个文件的贡献方式:代码生成讲解型 API/用法文档,文章生成展示页面,图片作为嵌入媒体。

主要能力:核心思路是逐单元读取文件夹并增量精炼文档,而非一次读完再写,从而突破上下文窗口限制并产出连贯、去重的结果。流程包括:用 AskUserQuestion 收集来源、产品 id、标题与是否部署;解析源文件夹(GitHub URL 用 git clone --depth 1,本地路径只读,绝不写入源目录);用 scripts/inventory.py 生成文件清单与分类;用 scripts/scaffold_docs.py 搭建站点(basePath 为 /docs);用 scripts/copy_assets.py 把图片复制到 public/assets/ 并返回路径映射;随后按顺序逐单元撰写或改进 MDX 页面,并回溯优化早期页面、简介、交叉链接与侧边栏顺序。

使用方式:需 Node.js 18+、npx、git、Python 3.8+,可选 Pillow 做图片优化,部署需 Vercel CLI 与 lovstudio-deploy-to-vercel 技能。命令示例:python3 "$SKILL_DIR/scripts/inventory.py" --src "<src>" --out /tmp/manifest.json;python3 "$SKILL_DIR/scripts/scaffold_docs.py" --product-id "<id>" --out "<docs-out-dir>" --title "<Title>" --pm pnpm;python3 "$SKILL_DIR/scripts/copy_assets.py" --src "<src>" --site "<docs-out-dir>" --out /tmp/assets-map.json。完成后用 pnpm build 本地验证,再委托部署并确认线上 URL 返回 200。

适用场景:需要为代码仓库、文章集或混合知识文件夹生成可导航、图文丰富的文档站时。

限制:源文件夹只读,文档站为独立目录;大文件夹可分批交给子代理,但主线程需统一维护信息架构;具体收费、价格与效果资料暂未提供。