现在使用git做版本管理的越来越多,所以项目的说明文档很多都是由markdown来编写,在项目根目录下创建一个readme.md文件来描述项目的结构说明,目录结构可以手动输入,为了格式整齐也可以使用开源软件mddir生成,本文使用mddir制作了bat执行脚本,可以方便快捷的生成目录结构的.md文件。
npm install mddir -g
- 为方便生成目录结果,写了个 bat 执行脚本
@Echo off
Set mddirPath=C:\node\node_global\node_modules\mddir\src
Set projectPath="E:\dhq-project"
Set readMe=directoryList.md
?
@echo --------------------打开mddir路径
cd /d %mddirPath%
@echo --------------------生成 %readMe%
node mddir %projectPath%
@echo --------------------复制文件 %readMe% 至 %projectPath%
copy %mddirPath%\%readMe% %projectPath%
@echo --------------------删除文件 %mddirPath%\%readMe%
del %mddirPath%\%readMe%
pause
- 生成后的目录结构,目录要使用代码块手动包起来,这样格式会更好
|-- dhq-project
|-- base
|-- croe
|-- database
|-- upgrade