Skip to content

Commit 1d209a8

Browse files
committed
Add useful development informatinos on VuePress
1 parent 0ed24e9 commit 1d209a8

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The development is done on the dev branch, since master is hosting the productio
77

88
### Deploy
99

10-
Start a development server with hot reload on `localhost:8080`:
10+
Start a development server with hot reload on `localhost:8080/docs/`:
1111
```bash
1212
npx vuepress dev pages/
1313
```
@@ -23,6 +23,46 @@ Build and deploy on GitHub Pages:
2323
npm run deploy
2424
```
2525

26+
### Development
27+
28+
```
29+
.
30+
├── pages
31+
│ ├── .vuepress (Optional)
32+
│ │ ├── components (Optional)
33+
│ │ ├── theme (Optional)
34+
│ │ │ └── Layout.vue
35+
│ │ ├── public (Optional)
36+
│ │ ├── styles (Optional)
37+
│ │ │ ├── index.styl
38+
│ │ │ └── palette.styl
39+
│ │ ├── templates (Optional, Danger Zone)
40+
│ │ │ ├── dev.html
41+
│ │ │ └── ssr.html
42+
│ │ ├── config.js (Optional)
43+
│ │ └── enhanceApp.js (Optional)
44+
│ │
45+
│ ├── README.md
46+
│ ├── manual
47+
│ │ └── README.md
48+
│ └── anotherpage.md
49+
50+
└── package.json
51+
```
52+
53+
- `docs/.vuepress`: It is used to store global configuration, components, static resources, etc.
54+
- `docs/.vuepress/components`: The Vue components in this directory will be automatically registered as global components.
55+
- `docs/.vuepress/theme`: Used to store local theme.
56+
- `docs/.vuepress/styles`: Stores style related files.
57+
- `docs/.vuepress/styles/index.styl`: Automatically applied global style files, generated at the ending of the CSS file, have a higher priority than the default style.
58+
- `docs/.vuepress/styles/palette.styl`: The palette is used to override the default color constants and to set the color constants of Stylus.
59+
- `docs/.vuepress/public`: Static resource directory.
60+
- `docs/.vuepress/templates`: Store HTML template files.
61+
- `docs/.vuepress/templates/dev.html`: HTML template file for development environment.
62+
- `docs/.vuepress/templates/ssr.html`: Vue SSR based HTML template file in the built time.
63+
- `docs/.vuepress/config.js`: Entry file of configuration, can also be yml or toml.
64+
- `docs/.vuepress/enhanceApp.js`: App level enhancement.
65+
2666
### License
2767

2868
The codebase is available under the terms of GNU [General Public License, version 3](LICENSE.txt).

0 commit comments

Comments
 (0)