在markdown中插入项目目录结构

东明兄 2021-01-02
0条评论 43 次浏览
东明兄 2021-01-020条评论 43 次浏览

全局安装tree:

sudo npm i tree-node-cli -g

查看所有指令:

tree --help

进入项目根目录,我们需要在README.md文件中写入目录,执行:

tree -L 4 -I "node_modules" > README.md

其中参数-L 是确定要几级目录,-I是排除哪个文件夹下的

如果生成的结构是乱的,可以用 代码块三点语法 包起来

├── README.md
├── babel.config.js
├── movefile.sh
├── package-lock.json
├── package.json
├── public
│   ├── favicon.ico
│   └── index.html
├── remove_be_lock.sh
├── remove_fe_lock.sh
├── src
│   ├── App.vue
│   ├── api // api配置文件目录 根据后端的控制器来查分为不同的文件 
│   │   ├── base.model.ts 
│   │   ├── hotel.model.ts
│   │   ├── hotel.ts // 酒店相关的api 请求接口
│   │   ├── user.model.ts
│   │   └── user.ts // 用户相关的api 请求接口
│   ├── assets  // 静态资源目录
│   │   ├── images // 图片资源
│   │   ├── logo.png
│   │   └── styles // 样式表
│   │       ├── _base.less  // 基础样式 预处理变量等定义位置
│   │       ├── _changeVant.less // 修改 vant 组件的样式放在这里
│   │       ├── _reset.less // 消除浏览器差异样式
│   │       ├── _mixin.less // 封装的mixin
│   │       └── global.less // 全局公共样式
│   ├── components
│   │   └── HelloWorld.vue
│   ├── main.ts // 入口文件
│   ├── router
│   │   └── index.ts  // 路由
│   ├── shims-vue.d.ts
│   ├── store
│   │   └── index.ts
│   ├── utils
│   │   ├── ajax.ts // 请求数据 封装
│   │   └── fnc.ts // 通用的 功能函数 封装
│   └── views
│       ├── Home.vue
├── tsconfig.json
├── vela_build.sh
├── vue.config.js
└── yarn.lock
0

发表评论

邮箱地址不会被公开。