# 目录结构

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

├── docs
│   ├── .vuepress
│   │   ├── components
│   │   ├── theme
│   │   │   ├── components
│   │   │   ├── global-components
│   │   │   ├── Layout
│   │   │   │   ├── Layout.vue
│   │   │   │   └── 404.vue
│   │   │   └── styles
│   │   ├── public
│   │   ├── styles
│   │   │   ├── index.styl
│   │   │   └── palette.styl
│   │   ├── config
│   │   │   ├── index.js
│   │   │   ├── base.js
│   │   │   ├── markedown.js
│   │   │   ├── plugins.js
│   │   │   ├── themeConfig
│   │   │   │   ├── index.js
│   │   │   │   ├── base.js
│   │   │   │   ├── sidebar.js
│   │   │   │   └── nav.js
│   │   │   └── plugins.js
│   │   ├── config.js
│   │   └── enhanceApp.js
│   │
│   ├── guide
│   │   └── index.md
│   └── index.md
│
└── package.json

docs/index.md: 主页。

docs/.vuepress: 用于存放全局的配置、组件、静态资源等。

docs/.vuepress/components: 该目录中的 Vue 组件将会被自动注册为全局组件。

docs/.vuepress/theme: 用于存放本地主题。

docs/.vuepress/style: 用于存放样式相关的文件。

docs/.vuepress/public: 静态资源目录。

docs/.vuepress/config.js: 配置文件的入口文件。

docs/.vuepress/config/: 具体的拆分的配置。

docs/.vuepress/enhanceApp.js: 客户端应用的增强。

更多请见 默认的页面路由 (opens new window)

Copyright 2005-2019 Tencent Smart Retail All Right Reserved.