运行时依赖
无特殊依赖
安装命令
点击复制官方npx clawhub@latest install skylv-doc-generator
镜像加速npx clawhub@latest install skylv-doc-generator --registry https://cn.longxiaskill.com✓ 镜像可用
技能文档
README 生成器概览 自动分析代码库并生成一份全面、专业的 README.md。
何时使用
- 用户提出“生成 README”“创建文档”或“给这个项目写文档”
- 新项目尚无 README
- 现有 README 过期或不完整
工作原理 步骤 1:分析项目结构 运行:dir /b /s /a:d(Windows)或 find . -maxdepth 2 -type d(macOS/Linux)
步骤 2:检测项目类型 检查:package.json(JS)、setup.py/pyproject.toml(Python)、Cargo.toml(Rust)、go.mod(Go)、pom.xml(Java)
步骤 3:生成 README 章节
- 项目标题:取自 package.json name 或目录名
- 徽章:CI 状态、版本、许可证、下载量
- 一句话描述
- 功能:自动识别导出与主函数
- 安装:按检测到的类型给出标准安装方式
- 用法:从源码提取真实示例
- API 参考:解析函数签名
- 贡献指南 + 许可证
输出格式 输出完整 README.md,所有章节齐全。每行描述不超过 80 字符。包含真实徽章(shields.io)及源码中的实际代码示例。