GitHub README生成器
为你的GitHub项目创建专业的README.md：徽章、简介、功能、技术栈、安装、使用、环境变量、路线图、贡献指南、许可证和作者。
免费 在浏览器中运行 无需注册
正在加载GitHub README生成器…
您的文件绝不离开您的设备
如何使用GitHub README生成器
- 1
在此页面打开GitHub README生成器，它直接在浏览器中加载。
- 2
添加文件、文本或数值，并调整设置。
- 3
复制或下载结果。不会上传或存储任何内容。
关于此工具
README是每个仓库的首页，访客、招聘者和贡献者首先看到的就是它。这款GitHub README生成器通过一个简短的表单生成完整、结构清晰的README.md。填写项目信息，开启或关闭各个章节，选择技术栈，然后复制Markdown或下载文件。编辑期间草稿会保存在浏览器中。
如何创建README
- 输入项目名称、标语和描述。
- 填写GitHub仓库（user/repo）以生成徽章，如有在线演示也可填写其网址。
- 选择要包含的章节以及技术栈中的技术。
- 选择许可证：MIT、Apache 2.0、GPL 3.0、BSD 3-Clause、MPL 2.0或Unlicense，并填写作者。
- 查看预览，然后复制Markdown或下载README.md。
可包含的章节
- 来自shields.io的徽章：星标、许可证等。
- 简介和功能：项目做什么以及为什么。
- 技术栈：使用的语言和框架。
- 带代码块的安装和使用说明。
- 运行所需的环境变量。
- 路线图、贡献指南、许可证和作者。
好的README是什么样的
- 在最上方用一句话说明项目用途。
- 直观展示：顶部放一张截图或GIF，胜过几段文字。
- 安装步骤可直接复制粘贴：给出按顺序、能在全新机器上运行的准确命令。
- 命令或选项变化时及时更新。
可在Markdown编辑器中继续修改，用Markdown表格生成器添加表格，并在Markdown速查表中查阅语法。
常见问题
README应该包含什么？
项目用途、安装和使用方法、技术栈、贡献方式以及许可证。徽章和截图能帮助访客快速了解项目。
README文件放在哪里？
放在仓库根目录，命名为README.md。GitHub会自动在仓库页面显示它。
可以添加徽章吗？
可以。以user/repo的形式填写GitHub仓库，生成器就会添加对应的shields.io徽章。
可以选择哪些许可证？
MIT、Apache 2.0、GPL 3.0、BSD 3-Clause、MPL 2.0和Unlicense。也请把完整的LICENSE文件添加到仓库中。
草稿会保存吗？
会，保存在浏览器的本地存储中，在同一设备上回来时内容仍在。
可以制作个人主页README吗？
可以。创建一个与你的用户名完全相同的仓库，用其中的README介绍自己，GitHub会把它显示在你的个人主页上。
相关工具
在线Markdown编辑器实时预览的Markdown编辑器。支持表格、任务列表和代码块，自动保存，可打开.md文件并导出为Markdown、HTML或PDF。Markdown 转 HTML 转换器将 Markdown 转换为干净的 HTML，支持 GitHub Flavored Markdown、表格、任务列表和代码块。实时预览，输出经过净化，可选完整页面或片段。HTML转Markdown转换器把HTML转换为干净的Markdown，适用于文档、README和博客迁移。可选择标题、列表符号、粗体、斜体和代码块样式。粘贴代码或上传文件即可。Markdown 表格生成器在类似电子表格的编辑器中创建 Markdown 表格：增删行列、设置列对齐、从 Excel 或 CSV 粘贴，并复制整齐的 Markdown。