SuperAPI AI 工具集

lov-repo2docs

写作与研究

查看项目

更新于 10-15 17:17

技能介绍

用途:把代码仓库、文章集合或图文混合文件夹统一视为“素材文件夹”,生成结构完整、可导航、含图片的 Fumadocs 文档站,并可选部署到 https://{product-id}.example.com/docs。

主要能力:按文件类型分类处理——代码转成有讲解的 API/用法文档,文章转成正式页面,图片作为媒体嵌入;先建立清单再逐单元增量打磨大纲与页面,可回溯改进早期页面,避免一次性读写全部内容。提供脚本:inventory.py 枚举并分类文件夹(不读取全文),scaffold_docs.py 生成站点骨架并设置 basePath: '/docs',copy_assets.py 复制图片到 public/assets/ 并返回路径映射(有 Pillow 时可压缩转码 HEIC/TIFF/BMP)。

使用方式:先 export SKILL_DIR="${SKILL_DIR:-$(pwd)}",用 AskUserQuestion 确认来源、product id、标题与是否立即部署;再依次执行清单、脚手架、资源复制,随后按顺序读取每个单元、写入或优化 MDX 页面并更新 meta.json;最后 cd "<docs-out-dir>" && pnpm build 验证构建,若需部署则委托 lov-deploy-to-vercel,并确认线上地址返回 200。代码仓库来源可 git clone --depth 1 <url> <tmp>/src,始终不写入源文件夹。

依赖:Node.js 18+、npx、git、Python 3.8+;图片优化可选 Pillow(pip install Pillow);部署需 Vercel CLI(npm i -g vercel)。

适用场景:代码库或文章集需要成体系的文档站;图文混合知识文件夹需要整理成可导航站点。

限制:具体到该技能的收费、价格、效果评测与完整平台支持范围暂未提供;部署默认使用 example.com 域名并依赖外部部署技能,网络受限时需配置代理。