新建项目时需要在 README.md 中对项目的目录和文件结构进行简单的说明。
但是手动编写的话,对于小的项目来说还好,没有太多结构。但是如果项目比较复杂,目录结构很多就麻烦了。
不过我们可以利用工具,自动生成项目目录结构,直接拿来用。下面教程开始:
1、全局安装 mddir :
代码语言:javascript复制npm install mddir -g
2、mddir 使用:
生成当前目录结构:
代码语言:javascript复制mddir
指定绝对路径:
代码语言:javascript复制mddir /path/projectName
相对路径:
代码语言:javascript复制mddir ~/Documents/path
自动忽略 node_modules 和 .git 文件夹。
稍等几秒,执行成功后会在根目录生成一个 directoryList.md 文件,打开就可以看到自动生成的项目目录结构了。
代码语言:javascript复制|-- w3h5.com
|-- .bowerrc
|-- .gitignore
|-- CONTRIBUTING.md
|-- FAQ.md
|-- LICENSE.md
|-- README.md
|-- package.json
|-- docs
......
然后复制到 README.md 自述文件中就可以了,方便快捷。
未经允许不得转载:w3h5-Web前端开发资源网 » 给README.md自述文件快速生成项目目录结构