新建仓库五分钟，写 README 两小时。填项目名、勾需要的模块，右侧实时预览 Markdown 与自动目录，附三套模板、徽章语法与特殊字符转义，最后复制或下载 README.md。
预览只覆盖标题、列表、代码块、行内代码、链接与加粗这些 README 常用语法；复杂表格与 HTML 请在目标平台核对。
| 模块口径 | 每个勾选的模块生成一个二级标题与对应段落，未勾选不输出空标题，避免 README 里出现空节。 |
|---|---|
| Markdown 转义 | 标题与正文里的反斜杠、反引号、星号、方括号等会按需转义；代码块内容保持原样并放进围栏。 |
| 徽章 | 只生成 shields.io 风格的纯文本链接语法，不请求外部图片；是否需要联网由你粘贴到的平台决定。 |
| 目录 | 目录按已勾选模块自动生成锚点，中文与空格会规范化，重复标题自动加序号。 |
| 模板 | 内置命令行工具、前端库、Web 服务三套模板，套用会替换当前表单，但不自动下载文件。 |
| 字数统计 | 按 Unicode 字符统计预览区字符数，包含代码块与链接语法，用于粗略判断篇幅。 |
新建仓库五分钟，写 README 两小时。README 生成器把项目说明拆成可勾选的模块，左侧填内容、右侧实时预览，顺手生成目录、安装命令、徽章与许可证段落，最后复制或下载成 README.md。
目录结构建议只写两层，超过两层维护成本会迅速上升；把细节留给项目里的 docs 目录。
常见结构为项目名与一句话简介、徽章、功能特性、安装、快速开始、用法示例、目录结构、API 或配置说明、贡献指南、许可证与致谢。本页把这些做成可勾选模块，按需要取舍即可，不必全填。
能。目录使用标准 Markdown 锚点链接，GitHub、Gitee 与多数静态站点生成器都会为标题自动生成同名锚点。中文标题与空格已在生成时规范化，重复标题会追加序号避免指向错误。
本页只生成徽章的 Markdown 链接语法，不在工具页里发起任何外部请求。粘贴到仓库后是否加载图片，取决于托管平台与你的网络环境；不想要外链可以直接取消勾选徽章模块。
不会。标题与正文里的反斜杠、反引号、星号、方括号、竖线等会做 Markdown 转义；代码块内容保持原样并放入围栏，导出后再贴到编辑器里不会破坏排版。
不会。表单、预览与导出都在浏览器内完成，配置保存在本机 localStorage。只有主动点「导出配置」才会生成一份本地 JSON 文件。
预览是本页的轻量渲染，只覆盖标题、列表、代码块、行内代码、链接与加粗这些 README 常用语法；复杂表格、脚注与 HTML 请以下载出的 Markdown 在目标平台的实际渲染为准。
现在只有你自己能看到这条留言（已标上「待审核」），管理员审核通过后才会展示给所有人～
还没有留言，来抢沙发吧！