微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

Readme.md中生成项目目录结构

需求:当编写项目文档时,需要在 README.md 中对项目整体的目录结构以及文件功能进行说明。

1、安装HomeBrew

参考:Mac安装HomeBrew&HomeBrew安装yarn_梦魇米莉的博客-CSDN博客

2、使用HomeBrew安装tree

brew install tree

3、使用 tree 在控制台生产当前目录树

// 因为实例项目为 js 项目,所以忽略了 node_modules,可根据真实项目选择性忽略文件目录,防止文件树过长
tree -I node_modules > tree.text

4、复制目录树文本到 README.md 中

执行上一步会生成一个tree.text文件,打开复制其中的内容

 

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 [email protected] 举报,一经查实,本站将立刻删除。

相关推荐