Skip to content

Commit 5c36ef8

Browse files
committed
Update development infos
1 parent a8fc864 commit 5c36ef8

File tree

1 file changed

+22
-13
lines changed

1 file changed

+22
-13
lines changed

README.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ This is the CoderBot documentation repository: a [Vue.js](https://vuejs.org/) ap
44

55
The development is done on the dev branch, since master is hosting the production build, served by GitHub pages (automatically deployed by an npm script, see package.json).
66

7+
```bash
8+
git clone https://github.com/CoderBotOrg/docs.git
9+
npm install
10+
```
711

812
### Deploy
913

@@ -12,7 +16,7 @@ Start a development server with hot reload on `localhost:8080/docs/`:
1216
npx vuepress dev pages/
1317
```
1418

15-
Production build:
19+
Production build (destionation: `pages/.vuepress/dist`):
1620
```bash
1721
npx vuepress build pages/
1822
```
@@ -50,18 +54,23 @@ npm run deploy
5054
└── package.json
5155
```
5256

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.
57+
- `pages/.vuepress`: It is used to store global configuration, components, static resources, etc.
58+
- `pages/.vuepress/components`: The Vue components in this directory will be automatically registered as global components.
59+
- `pages/.vuepress/theme`: Used to store local theme.
60+
- `pages/.vuepress/styles`: Stores style related files.
61+
- `pages/.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.
62+
- `pages/.vuepress/styles/palette.styl`: The palette is used to override the default color constants and to set the color constants of Stylus.
63+
- `pages/.vuepress/public`: Static resource directory.
64+
- `pages/.vuepress/templates`: Store HTML template files.
65+
- `pages/.vuepress/templates/dev.html`: HTML template file for development environment.
66+
- `pages/.vuepress/templates/ssr.html`: Vue SSR based HTML template file in the built time.
67+
- `pages/.vuepress/config.js`: Entry file of configuration, can also be yml or toml.
68+
- `pages/.vuepress/enhanceApp.js`: App level enhancement.
69+
70+
Image assets using the $baseURL helper
71+
```html
72+
<img :src="$withBase('/foo.png')" alt="foo">
73+
```
6574

6675
### License
6776

0 commit comments

Comments
 (0)