Skip to content

Commit f567972

Browse files
committed
docs: add directory
1 parent 2ef6dbe commit f567972

File tree

2 files changed

+98
-0
lines changed

2 files changed

+98
-0
lines changed

.vitepress/config.ts

+5
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ const Guides: DefaultTheme.NavItemWithLink[] = [
66

77
const vue3VantMobile: DefaultTheme.NavItemWithLink[] = [
88
{ text: '介绍', link: '/vue3-vant-mobile/' },
9+
{ text: '目录结构', link: '/vue3-vant-mobile/directory'},
910
{ text: '图标', link: '/vue3-vant-mobile/icons' },
1011
]
1112

@@ -189,6 +190,10 @@ export default defineConfig({
189190
'/vue3-element-admin/': vue3ElementAdminSidebarConfig,
190191
},
191192

193+
outline: {
194+
label: '页面导航',
195+
},
196+
192197
editLink: {
193198
pattern: 'https://github.com/easy-temps/easy-docs/edit/main/:path',
194199
text: '在 GitHub 上编辑此页面',

vue3-vant-mobile/directory.md

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
title: 目录结构
3+
---
4+
5+
# :open_book: 目录结构
6+
7+
模板文件结构说明。
8+
9+
```yaml
10+
.
11+
├─ .github # GitHub 配置文件
12+
│ ├─ workflows # 工作流
13+
│ │ └─ release.yml # 发布任务
14+
│ └─ CODE_OF_CONDUCT.md # 参与者行为规范
15+
├─ .husky # 代码提交前校验配置文件
16+
│ ├─ commit-msg # git commit 钩子
17+
│ └─ pre-commit # eslint 钩子
18+
├─ .vscode # IDE 工具推荐配置文件
19+
│ ├─ extensions.json # 模板推荐的 vscode 插件
20+
│ └─ settings.json # 设置扩展程序或 vscode 编辑器的一些属性
21+
├─ build # 构建工具
22+
│ └─ vite # vite 配置相关
23+
│ ├─ index.ts # vite 相关插件存放处
24+
│ ├─ optimize.ts # vite 依赖预构建配置项
25+
│ └─ vconsole.ts # vconsole 配置项
26+
├─ mock # mock 模拟后台数据
27+
│ ├─ modules # mock 模块
28+
│ ├─ data.ts # 定义 mock 数据
29+
│ ├─ index.ts # 导出 mock 模块
30+
│ └─ util.ts # mock 工具包
31+
├─ node_modules # 项目依赖
32+
├─ public # 静态资源
33+
│ ├─ favicon-dark.svg # favicon dark
34+
│ ├─ favicon.svg # favicon
35+
│ ├─ pwa-192x192.png # PWA 192
36+
│ ├─ pwa-512x512.png # PWA 512
37+
│ └─ safari-pinned-tab.svg # 专属 Safari 浏览器图标
38+
├─ scripts # 公共脚本
39+
│ └─ verifyCommit.js # git commit 前置校验
40+
├─ src
41+
│ ├─ api # 接口请求统一管理
42+
│ ├─ assets # 字体、图片等静态资源
43+
│ ├─ components # 自定义通用组件
44+
│ │ ├─ Chart # 封装图表组件
45+
│ │ ├─ Container.vue # 内容包装组件
46+
│ │ ├─ NavBar.vue # 顶部菜单栏组件
47+
│ │ ├─ TabBar.vue # 底部菜单栏组件
48+
│ │ └─ ...
49+
│ ├─ composables # 组合函数
50+
│ │ └─ dark.ts # Dark 模式相关函数
51+
│ ├─ hooks # 钩子函数
52+
│ │ └─ useAutoThemeSwitcher.ts # 处理自动切换模式的钩子
53+
│ ├─ locales # 国际化文件存放处
54+
│ │ ├─ en-US.json # 英文配置
55+
│ │ └─ zh-CN.json # 中文配置
56+
│ ├─ pages # 存放编写业务代码页面
57+
│ ├─ router # 路由配置
58+
│ ├─ stores # Pinia 状态管理
59+
│ ├─ styles # 全局样式
60+
│ │ ├─ app.less # 全局样式
61+
│ │ └─ var.less # 样式变量
62+
│ ├─ utils # 全局工具方法
63+
│ │ ├─ auth.ts # 处理用户信息和 token 相关
64+
│ │ ├─ request.ts # 封装 axios 文件
65+
│ │ └─ i18n.ts # vant 语言包和业务语言包初始化
66+
│ ├─ App.vue # 入口页面
67+
│ ├─ auto-imports.d.ts # Vue3 组合式 API 类型声明文件
68+
│ ├─ components.d.ts # 组件自注册类型声明文件
69+
│ ├─ env.d.ts # 全局 TypeScript 类型
70+
│ ├─ main.ts # 入口文件
71+
│ ├─ typed-router.d.ts # 文件路由类型声明
72+
│ └─ vue-router.d.ts # 全局路由类型声明
73+
├─ tests # 单元测试
74+
│ └─ index.spec.ts # 最小示例
75+
├─ .editorconfig # 编辑器读取文件格式及样式定义配置
76+
├─ .env # 全局环境变量配置
77+
├─ .env.development # 开发环境变量配置
78+
├─ .env.production # 生产环境变量配置
79+
├─ .gitignore # git 提交忽略文件
80+
├─ .npmrc # npm 配置文件
81+
├─ eslint.config.ts # eslint 语法检查配置
82+
├─ index.html # html 主入口
83+
├─ LICENSE # 证书
84+
├─ netlify.toml # Netlify 项目部署的配置
85+
├─ pnpm-lock.yaml # 依赖包版本锁定文件
86+
├─ package.json # 依赖包管理以及命令配置
87+
├─ README.md # README(英文版)
88+
├─ README.zh-CN.md # README(中文版)
89+
├─ tsconfig.json # typescript 配置
90+
├─ uno.config.ts # unocss 配置
91+
└─ vite.config.ts # vite 配置
92+
93+
```

0 commit comments

Comments
 (0)