在 README.md 中生成项目目录结构

简介: 在 README.md 中生成项目目录结构

在 README.md 中生成项目目录结构


1.使用 Homebrew 安装 tree

//打开终端输入
brew install tree


image.png


笔者之前已经安装好,上图为演示图


2.使用tree生成树


//全输出

tree > tree.md

// 实例项目为 js 项目,忽略 node_modules,可根据真实项目选择性忽略文件目录,防止文件树过长

tree -I node_modules > tree.md


微信图片_20220429232045.jpg


效果如图:

Lock
├── Demon01.py
├── Demon02.py
├── Demon03.py
├── Demon04.py
├── Demon05.py
├── Demon06.py
├── Demon07.py
├── Demon08.py
├── Demon09.py
├── Demon10.py
├── Demon11.py
├── Demon12.py
├── Demon13.py
├── Lin.py
├── images
│   ├── 4people.JPG
│   ├── SJbridge01.jpeg
│   ├── biyezhao01.jpg
│   ├── chepai01.jpeg
│   ├── china01.PNG
│   ├── china02.PNG
│   ├── china03.png
│   ├── dym01.JPG
│   ├── dym02.JPG
│   ├── dym03.JPG
│   ├── dym04.JPG
│   ├── hezhao3r01.jpg
│   ├── jucan.JPG
│   ├── labBuilding01.jpeg
│   ├── lsy01.JPG
│   ├── lsy02.JPG
│   ├── lt01.jpeg
│   ├── lt02.jpeg
│   ├── lt03.jpeg
│   ├── lyy01.JPG
│   ├── lyy02.JPG
│   ├── lyy03.JPG
│   ├── paifang01.jpeg
│   ├── paifang02.jpeg
│   ├── plate01.jpeg
│   ├── plate02.jpeg
│   ├── plate03.jpeg
│   ├── plate04.jpeg
│   ├── plate05.jpeg
│   ├── womeng.JPG
│   ├── xy01.JPG
│   ├── xy02.JPG
│   ├── xy03.JPG
│   ├── xy04.JPG
│   ├── xy05.JPG
│   └── xy06.JPG
├── result
│   ├── CannySJbridge01.jpeg
│   ├── binarydym01.JPG
│   ├── binarydym02.JPG
│   ├── binarydym03.JPG
│   ├── binarydym04.JPG
│   ├── binarylsy01.JPG
│   ├── binarylyy02.JPG
│   ├── binarylyy03.JPG
│   ├── binarypaifang01.jpeg
│   ├── binarypaifang02.jpeg
│   ├── binarywomeng.JPG
│   ├── binaryxy05.JPG
│   ├── contoursdym01.JPG
│   ├── contoursdym02.JPG
│   ├── contoursdym03.JPG
│   ├── contoursdym04.JPG
│   ├── contourslsy01.JPG
│   ├── contourslyy02.JPG
│   ├── contourslyy03.JPG
│   ├── contourspaifang01.jpeg
│   ├── contourspaifang02.jpeg
│   ├── contourswomeng.JPG
│   ├── contoursxy05.JPG
│   ├── savedanceDu.avi
│   └── shoot.png
├── tree.md
└── videos
    ├── Lin01.mp4
    ├── danceDu.avi
    └── danceDu.mp4
3 directories, 79 files
相关文章
|
3月前
|
Linux
【Linux 或Mac系统】自动生成项目结构目录并放在README.md文件中
如何在Linux或Mac系统中使用tree命令自动生成项目结构目录,并将其格式化后放入项目的README.md文件中以展示项目结构。
103 1
|
4月前
GitHub——README.md挂件如何生成
使用`shields.io`即可生成github的markdown的挂件
33 0
GitHub——README.md挂件如何生成
|
3月前
|
应用服务中间件 nginx
Docsify——部署后显示404且无法访问README.md
Docsify——部署后显示404且无法访问README.md
33 0
|
6月前
|
数据可视化 算法 API
【README.md 指南 】如何编写 README.md:打造出色的开源项目文档
【README.md 指南 】如何编写 README.md:打造出色的开源项目文档
2961 0
|
程序员 C++
C++程序文件的目录结构
C++程序文件的目录结构
243 0
给项目写README文档
给项目写README文档
91 0
|
JavaScript 前端开发 Java
SpringBoot+Vue+kkFileView实现txt、doc、docx、md等文件在线预览)
SpringBoot+Vue+kkFileView实现txt、doc、docx、md等文件在线预览)
|
开发者
最简单方法创建 README
最简单方法创建 README
590 0
最简单方法创建 README
github—如何在README.md文件中添加图片
版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/qq_34173549/article/details/80551021 1、在github上的仓库建立一个存放图片的文件夹,文件夹名字随意。
10474 1
|
监控 Linux Shell
从《README》了解u-boot
从《README》了解u-boot
178 0