SuperAPI AI 工具集

readme-generator

通用与其它

查看项目

更新于 10-16 00:22

技能介绍

用途:该技能用于生成或重排 README.md,采用特定的居中、基于表格的版式,适用于项目文档的创建与格式化。

主要能力:统一顶部结构(居中 <div> 包裹标题、图标、标语、徽章与核心价值语句);用表格承载功能列表、步骤与工作流;支持表格单元格内的 Markdown;按技术栈选择 shields.io 徽章颜色;生成前会分析代码库以获取真实版本号。

使用方式:生成前检查依赖文件(如 package.json、build.gradle、pom.xml、pyproject.toml、requirements.txt 等);若找不到版本信息需先询问用户,用户确认后方可用 latest。已有 README 时默认在保留事实内容前提下重排为居中表格结构,用户明确要求“重写”时才修改内容本身。徽章格式为 https://img.shields.io/badge/{LABEL}-{MESSAGE}-{COLOR}?style=flat。

限制:禁止使用表情符号与独立项目符号列表(表格单元格内的项目符号可用);除独立代码块外所有元素须居中;独立代码块不能放在 <div align="center"> 内,否则 GitHub 渲染会出错;表格单元格内的代码块没有问题。不得猜测或编造功能,只记录代码中实际存在的内容。除非用户明确要求,否则不包含 Contributing 章节。

适用场景:为各类项目(库、应用、工具、附加组件等)编写或统一 README 版式,尤其是需要居中表格风格和徽章规范的开源项目。

其他细节(如官方文本)暂未提供。