You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
With following the principle of `Convention is superior to configuration`, the recommended document structure is as follows:
3
+
VuePress follows the principle of **"Convention is better than configuration"**, the recommended document structure is as follows:
6
4
7
5
::: vue
8
6
.
9
7
├── docs
10
-
│ ├── .vuepress (_**Optional**_)
11
-
│ │ ├── `components`(_**Optional**_)
12
-
│ │ ├── `theme`(_**Optional**_)
8
+
│ ├── .vuepress _(**Optional**)_
9
+
│ │ ├── `components`_(**Optional**)_
10
+
│ │ ├── `theme`_(**Optional**)_
13
11
│ │ │ └── Layout.vue
14
-
│ │ ├── `public`(_**Optional**_)
15
-
│ │ ├── `styles`(_**Optional**_)
12
+
│ │ ├── `public`_(**Optional**)_
13
+
│ │ ├── `styles`_(**Optional**)_
16
14
│ │ │ ├── index.styl
17
15
│ │ │ └── palette.styl
18
-
│ │ ├── `emplates`(_**Optional,Danger Zone**_)
16
+
│ │ ├── `emplates`_(**Optional, Danger Zone**)_
19
17
│ │ │ ├── dev.html
20
18
│ │ │ └── ssr.html
21
-
│ │ ├── `config.js`(_**Optional**_)
22
-
│ │ └── `enhanceApp.js`(_**Optional**_)
19
+
│ │ ├── `config.js`_(**Optional**)_
20
+
│ │ └── `enhanceApp.js`_(**Optional**)_
23
21
│ │
24
22
│ ├── README.md
25
23
│ ├── guide
@@ -35,9 +33,9 @@ Please note the capitalization of the directory name.
35
33
36
34
-`docs/.vuepress`: It is used to store global configuration, components, static resources, etc.
37
35
-`docs/.vuepress/components`: The Vue components in this directory will be automatically registered as global components.
38
-
-`docs/.vuepress/theme`: Used to store local theme。
36
+
-`docs/.vuepress/theme`: Used to store local theme.
39
37
-`docs/.vuepress/style`: Stores style related files.
40
-
-`docs/.vuepress/style/index.styl`: Automatically imported global style files, generated at the end of the final file, have a higher priority than the default style.
38
+
-`docs/.vuepress/style/index.styl`: Automatically applied global style files, generated at the ending of the CSS file, have a higher priority than the default style.
41
39
-`docs/.vuepress/style/palette.styl`: The palette is used to override the default color constants and to set the color constants of Stylus.
0 commit comments