# 目录结构

VuePress 遵循 “约定优于配置” 的原则,推荐的目录结构如下:

.
├── docs
│   ├── .vuepress (可选的)
│   │   ├── components (自定义vue组件)
│   │   ├── theme (当前默认主题,继承自vuepress 默认主题)
│   │   │   ├── components (全局vue组件,继承自vuepress)
│   │   │   ├── global-components (全局vue组件,继承自vuepress)
│   │   │   ├── styles (主题前端样式)
│   │   │   └── Layout (布局组件)
│   │   ├── public (静态资源目录,目录中结构和docs中的文档结构保持一致,方便静态资源引入)
│   │   ├── styles (前端样式目录)
│   │   ├── util (工具方法)
│   │   │   └── index.js
│   │   ├── store (vuex配置)
│   │   ├── config (配置文件分包)
│   │   │   ├── headConf.js (html head)
│   │   │   ├── navConf.js (顶部菜单配置)
│   │   │   ├── pluginConf.js (插件配置)
│   │   │   └── sidebarConf.js  (侧边栏配置,弃用,目录自动生成)
│   │   ├── config.js (主配置文件)
│   │   └── enhanceApp.js (vue实例配置)
│   │ 
│   ├── dev-support 开发支持分包
│   └── README.md (首页)
│   
└── package.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26