README 生成器

填写项目介绍、功能、安装步骤和徽章，可选添加 API 或配置表格；实时预览 Markdown，然后复制或下载 README 文件。

README 生成器 — 创建专业的 GitHub 就绪 README.md 文件，支持徽章、API 参考表格、配置选项列表和实时 Markdown 预览

1. 选择格式预设快速入门：标准生成包含必要章节的均衡 README（标题、描述、功能特性、安装、使用、贡献指南、许可证），精简适合只需基本信息的轻量级项目（项目名、安装命令和简短描述），详细适用于需要完整 API 参考表格、配置选项表格、致谢、联系方式和支持章节的生产级开源库。每个预设会智能地切换相关章节——之后您始终可以手动启用或禁用各个章节进行微调。
2. 使用左侧结构化表单填写每个章节：在项目标题和标语区域提供项目名称和简介，在顶部选择要显示的徽章类型（许可证、版本、构建状态、NPM、下载量），以列表形式添加功能特性，选择包管理器（npm、yarn、pnpm、pip、cargo、go）自动生成正确的安装命令，添加带类型注释的配置选项（string、number、boolean、object、array）构建格式化选项表格，定义API 端点（含方法、路径、描述和认证要求）生成清晰的 API 参考章节。
3. 实时监控右侧预览面板——它会即时渲染您输入的 Markdown，精确展示在 GitHub、GitLab 或任何 Markdown 兼容平台上的最终效果。满意后，点击复制 Markdown将原始 Markdown 文本复制到剪贴板，或点击下载 README将 README.md 文件直接保存到您的设备。生成的 Markdown 遵循 CommonMark 和 GitHub Flavored Markdown (GFM) 规范——兼容 GitHub、GitLab、Bitbucket、Gitea 以及 Hugo、Jekyll、Docusaurus 等静态网站生成器。所有构建过程完全在浏览器中完成，您的项目详情不会离开您的设备。

请启用 JavaScript 以使用这些工具。