Skip to content

Commit a0bed4c

Browse files
committed
chore: document dev setup
1 parent 5c4b858 commit a0bed4c

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,31 @@ See the [Vue Docs Writing Guide](https://v3.vuejs.org/guide/writing-guide.html)
88

99
## Developing
1010

11-
1. Clone repository
11+
For now, local development requires cloning both this repo and `vuejs/theme`:
12+
13+
1. Clone repositories
1214

1315
```bash
1416
git clone [email protected]:vuejs/docs.git
17+
git clone [email protected]:vuejs/theme.git
1518
```
1619

17-
2. Install dependencies
20+
2. Link theme into docs repo
1821

1922
```bash
20-
yarn # or npm install
23+
# in ./theme
24+
yarn link
25+
26+
# in ./docs
27+
yarn link @vue/theme
2128
```
2229

23-
3. Start local development environment
30+
3. Install deps and start VitePress server
2431

2532
```bash
26-
yarn serve # or npm run serve
33+
# in ./docs
34+
yarn
35+
yarn serve
2736
```
2837

2938
## Deploying

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"build": "vitepress build src"
66
},
77
"devDependencies": {
8-
"@vue/theme": "vuejs/vue-theme",
8+
"@vue/theme": "vuejs/theme",
99
"vitepress": "^0.15.3"
1010
}
1111
}

0 commit comments

Comments
 (0)