1.0.1 • Published 2 years ago
sharegood-readme v1.0.1
自动文档生成器
- 该插件只适用于公司基于sharegood-ui的项目,非该类型项目使用时某些配置可能会读取不到 (sharegood-ui为公司内部围绕element二次封装的一套框架,其中包含各种规范配置和常用业务插件)
- 改插件是基于公司统一规范的readme文档进行编写,主要包含了:项目介绍,项目介绍,补充说明,环境依赖,接口域名,开发上手,代码提交,工程目录,发布部署,运维配置文件等模块
- 使用方法:安装完包后执行 npx updateReadme
- 更新命令:npm publish