各位贤达,在md写作中,如何生成目录,比如这样目录,是怎么生成的?全手工打不要打死一条命了?
https://gitee.com/zoomla/ZoomlaFont
https://gitee.com/zoomla/ZoomlaFont/blob/master/%E6%9C%AC%E5%8C%85%E7%9B%AE%E5%BD%95%E7%BB%93%E6%9E%84directoryList.md
tree命令就可以了,如果要生成链接的话可能得自己写脚本
在写项目 README.md 说明文档时,如果有一个 markdown 目录结构图就很 nice 了
例如:https://gitee.com/zoomla/ZoomlaFont
这个项目中,就有很好的目录结构。
逐浪字库仓库中的目录结构
前人栽树后人乘凉,无独有偶,npm 上已经有这样的一个包:mddir ,我们可以使用它来为项目生成目录结构图
使用如下:
1、项目中安装 mddir(如果要全局安装,需要将 mddir 配置环境变量)
yarn add mddir -D
或者
npm install mddir -g
2、执行命令,生成结构图
具体要生成哪个目录的结构图,看自己需求
$ node node_modules/mddir/src/mddir
注意:当前目录下必须有子目录,如果没有子目录是无法生成的。
如果你不需要指定在特定目录,则具体生成方法就是执行命令mddir
mddir
执行后,会有一段时间等待,视文件目录的大小而定。
在一段时间等待后,在当前目录下生成一个 directoryList.md 的 md 文件
内容如下:
内容如下:
|— Html5
|— .babelrc
|— .gitignore
|— README.md
|— directoryList.md
|— gulpfile.js