美文网首页
markdown 之项目目录文件结构展示

markdown 之项目目录文件结构展示

作者: 路遇惊喜 | 来源:发表于2018-09-21 11:52 被阅读0次

一般来说,我们为项目写readme文档时,都会对整个目录的项目结构做个说明。

例如这样的:

WX20180921-115053@2x.png

我们可以用mddir来生成项目目录结构:mddir

使用命令

node mddir "../relative/path/"

例子

打开终端或命令提示符,并cd进入mddir /src文件夹。

使用说明:

$ cd ~/Documents/demo-project
$ pwd
Users/username/Documents/demo-project
$ npm install mddir --save
$ cd node_modules/mddir/src
$ pwd
Users/username/Documents/node_modules/mddir/src
$ ls
mddir.js
$ node mddir "../../../"
// Exports 'directoryList.md' in mddir/src folder

如果没有指定路径,mddir将默认为mddir/src文件夹之上上的三个文件夹

(假设mddir安装在:project/node_modules/mddir/src中)。

生成的目录会忽略node_modules和.git文件夹。

相关文章

网友评论

      本文标题:markdown 之项目目录文件结构展示

      本文链接:https://www.haomeiwen.com/subject/dkeanftx.html