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

一般来说,我们为项目写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文件夹。

  • 3
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值