README.md 生成器
填写一个简短的表单，即可得到干净的 GitHub README.md，包含徽章、安装、使用、功能特性、贡献指南和许可证章节，并提供实时 Markdown 预览。
owner/repo，用于徽章和 git clone 命令。
每行一个特性。
章节标题使用英文，这是开源 README 的惯例。你输入的内容会原样保留。
相关工具
查看全部什么是 README 生成器？
README 是人们在代码仓库中读到的第一个文件。这个工具把几个字段——项目名称、描述、功能特性、安装和使用命令、许可证和作者——转换成结构良好的 README.md，并可选择加入 shields.io 徽章、目录和贡献指南。你可以在 Markdown 源码和渲染后的 预览 之间切换。
如何使用 README 生成器
- 输入 项目名称，如果项目在 GitHub 上，再以
owner/repo形式填写 GitHub 仓库。 - 添加 一句话简介、描述、功能特性（每行一个）、安装命令 和 使用示例。
- 选择 许可证，填写 作者，并切换 添加 shields.io 徽章（需要填写仓库）、目录 和 贡献指南章节。
- 查看 预览，然后复制或下载 README.md。
示例
Project name tiny-cache, tagline "A 1 KB LRU cache", repository acme/tiny-cache, install npm install, license MIT, no badges/TOC/contributing
# tiny-cache > A 1 KB LRU cache ## Installation ```bash git clone https://github.com/acme/tiny-cache.git cd tiny-cache npm install ``` ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
何时使用 README 生成器
适合在一分钟内为新的库、命令行工具、个人项目或内部仓库起草 README，然后再手工润色文字。它生成的是合理的骨架而不是文档：你仍然需要说明配置、API 细节以及项目特有的示例。
README 生成器 的工作原理
表单会被组装成 GitHub 风格的 Markdown：带项目名称的一级标题、可选的徽章（来自 img.shields.io 的许可证、星标、议题徽章，链接到仓库）、引用块形式的简介，然后是功能特性、安装（设置了仓库时包含 git clone + cd 代码块）、使用（用你选择的语言标注的围栏代码块）、贡献指南、许可证和作者章节。目录链接遵循 GitHub 的标题锚点规则。预览由 marked 渲染并用 DOMPurify 清理。
常见用例
- 为新的开源包快速搭建 README
- 统一团队仓库的 README 结构
- 快速添加许可证和贡献指南章节
- 为作品集或黑客松项目创建 README
常见问题
它也会创建 LICENSE 文件吗？
不会。它只添加一个链接到 LICENSE 的许可证章节；许可证文本本身需要你自己加入仓库（GitHub 可以帮你创建）。
为什么标题是英文的？
英文章节标题是开源 README 的惯例，便于全球贡献者快速浏览。你自己输入的文字仍保持你所用的语言。
徽章对私有仓库有效吗？
Shields.io 无法读取私有的 GitHub 仓库，所以星标和议题徽章只会显示公开仓库的数据。