填写项目名称、简介、功能特点、安装方式、使用示例和许可证,选择需要的徽章,自动生成结构清晰的 README.md,支持中文或英文标题和目录,右侧实时预览 GitHub 上的显示效果,复制或下载即可放进项目根目录。
项目配置文件可以用 package.json 生成器、.gitignore 生成器、.editorconfig 生成器 生成,CI 配置可以用 GitHub Actions 工作流生成器,检查写法可以用 Markdown 语法检查。
填写项目名称、GitHub 仓库、一句话简介、npm 包名、标题语言、许可证和作者,勾选需要的徽章,填写功能特点、使用示例、截图地址和路线图,选择是否生成目录、参与贡献和标题居中;右侧预览效果,复制或下载 README.md。
项目是什么、为什么用、怎么安装和使用、怎么参与贡献,以及使用什么许可证。
勾选需要的徽章,工具会生成 shields.io 的图片链接。
面向国内用户可以用中文,开源给国际用户时建议同时提供英文版本。
勾选“目录”,工具会根据二级标题生成可以点击跳转的目录。
生成的是通用结构,请按项目实际情况补充配置说明、常见问题等内容;徽章图片由 shields.io 和 GitHub 实时生成,预览时需要能访问这些服务。
所有内容在浏览器本地生成,不会上传。
构建状态徽章显示 no status 时,确认工作流文件名是 ci.yml 并且至少运行过一次。
GitHub Actions 工作流生成器 · .gitignore 生成器 · CSS Transform 变换生成器 · HMAC 签名生成与验证 · 全部开发工具