ReadMe编写

ReadMe编写

• 项目简介
• 功能特性
• 环境依赖
• 架构流程图
• 部署步骤
• 目录结构
• License

生成README文件

npx readme-md-generator -y
npx readme-md-generator -p path/to/my/own/template.md  //模板在项目里

https://github.com/kefranabg/readme-md-generator

生产Markdown目录

1.下载二进制文件

$ wget https://github.com/ekalinin/github-markdown-toc.go/releases/download/1.1.0/gh-md-toc.linux.amd64.tgz
$ tar xzvf gh-md-toc.linux.amd64.tgz
$ ./gh-md-toc --version

2. 使用

./gh-md-toc README.md

相关链接

https://www.jianshu.com/p/302abe331dcb
https://www.cnblogs.com/wj-1314/p/8547763.html