开发工具

README 生成 - 开源项目文档骨架

填写项目名与简介,勾选安装、用法、API、贡献等章节后生成结构化 README.md,适合初始化开源仓库或 NPM 包文档骨架,导出前可预览与复制。

READMEMarkdown文档

收藏工具

当前还没有选择收藏模式。

快捷操作

返回开发工具 浏览全部工具

你可以复制当前工具页链接,或在支持的设备上调用系统分享。

开发工具

README 生成

填写项目名与简介,勾选安装、用法、API、贡献等章节后生成结构化 README.md,适合初始化开源仓库或 NPM 包文档骨架,导出前可预览与复制。

生成的 README.md

使用场景

  • 新仓库快速搭 README 骨架
  • 统一安装与用法章节结构
  • 导出 README.md 再手工细化

如何使用

  1. 填写项目名称与短描述
  2. 勾选需要的文档章节
  3. 复制或导出生成的 README.md

示例输入输出

项目

Cool-App + Installation/Usage

结构

# Cool-App\n## Installation\n## Usage

FAQ

生成内容能直接发布吗?

通常还需补充真实安装命令、截图与示例;工具提供结构与占位,不替代项目真实信息。

可以去掉某些章节吗?

可以。取消对应勾选后,输出中就不会包含该节。

工具列表

相关推荐

你可以从这里继续打开相近场景的工具,减少重复搜索。

Changelog 生成

发版日志 - Keep a Changelog 模板

可用

按版本分类填写新增、变更、废弃、移除、修复与安全项,生成 Keep a Changelog 风格 Markdown,适合整理发版说明。

Changelog 发版 Markdown

开源许可证生成

开源许可证 - 常见 License 文本

可用

选择 MIT、Apache-2.0、GPL 等常见开源许可证并填入版权人,生成可保存为 LICENSE 的标准文本,适合在创建仓库时快速放入合规声明(不构成法律咨询)。

License 开源 合规

Shields 徽章构建

Shields.io 徽章 - Markdown 生成器

可用

可视化配置标签、文案、颜色、样式与图标,实时预览并生成 Shields.io 徽章的 Markdown/URL,适合在 README 中展示构建状态、版本或技术栈标识。

Shields 徽章 Markdown