README 生成器

README 生成器常见问题

README 生成器怎么使用？

先填写或调整「安装」、「使用示例」、「API 文档」、「许可证」，再使用「生成 README」、「预览」完成操作。可先用「安装」中的示例 「my-package」熟悉输入格式，再替换成自己的数据。

处理模式有哪些选项？

本页提供「License MIT」、「License Apache 2.0」、「Version」、「Build Passing」、「Build Failing」、「Coverage」、「npm」、「Downloads」、「GitHub Stars」等选项。先按实际输入和目标选择对应模式，再执行操作；比较两次结果时，保持其他参数一致，避免把不同模式的结果混在一起。

README 生成器的结果应怎样理解？

先用最小示例验证，再将结果放回实际开发环境检查。语言版本、运行环境、编码和配置项可能与浏览器中的处理规则不同。

输入内容会保存或发给外部服务吗？

本页的主要处理逻辑在浏览器内执行。页面加载资源、打开外部链接，以及带外部地址的内容预览仍可能产生网络请求；“本地处理”并不表示整个网页完全没有网络活动。

没有结果或操作失败时先检查什么？

先检查「安装」、「使用示例」、「API 文档」是否完整，以及格式、单位和当前选项是否匹配。重新执行「生成 README」，查看页面的结果或错误提示；可先用少量数据定位问题。此工具还依赖额外的脚本资源；首次使用需等资源加载完成，资源加载失败时请恢复网络后刷新。

相关工具

Markdown 转 HTML 转换器 · Markdown 语法检查器 · OpenAPI/Swagger查看器 · README.md 实时预览器 · 全部开发工具