Skip to content

Commit 5be6399

Browse files
authored
docs: Make scaffolding path a first-class citizen for getting started (#2450)
* docs: surface scaffolding tool on home page * docs: add quick start section to getting started * style: fix linting error * docs: fix grammatical errors
1 parent 1ed9c35 commit 5be6399

File tree

2 files changed

+36
-11
lines changed

2 files changed

+36
-11
lines changed

packages/docs/docs/README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,20 @@ footer: MIT Licensed | Copyright © 2018-present Evan You
2828
### As Easy as 1, 2, 3
2929

3030
``` bash
31-
# install
32-
yarn global add vuepress
33-
# OR npm install -g vuepress
31+
# Scaffold VuePress site
32+
yarn create vuepress [directoryName]
33+
# OR npx create-vuepress [directoryName]
3434

35-
# create a markdown file
36-
echo '# Hello VuePress' > README.md
35+
# Navigate to your new VuePress directory
36+
cd [directoryName]
3737

38-
# start writing
39-
vuepress dev
38+
# Start local dev server
39+
yarn dev
40+
# OR npm run dev
4041

41-
# build to static files
42-
vuepress build
42+
# Build static files
43+
yarn build
44+
# OR npm run build
4345
```
4446

4547
::: warning COMPATIBILITY NOTE

packages/docs/docs/guide/getting-started.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,31 @@
44
VuePress requires [Node.js](https://nodejs.org/en/) >= 8.6.
55
:::
66

7+
## Quick Start
8+
9+
The fastest way to get your VuePress project setup is to use our create-vuepress tool which will help scaffold the basic VuePress site structure for you.
10+
11+
To use it, open up your terminal in the desired directory and run the following command:
12+
13+
```bash
14+
yarn create vuepress [directoryName]
15+
# OR npx create-vuepress [directoryName]
16+
```
17+
18+
You will be prompted to choose which boilerplate you prefer. For most users, the `docs` boilerplate is what you will want.
19+
20+
You will then have the opportunity to configure your VuePress site’s metadata such as:
21+
22+
- Project Name
23+
- Description
24+
- Maintainer Email
25+
- Maintainer Name
26+
- Repository URL
27+
28+
Once it is complete, you should see your new VuePress site scaffolded in your directory! :tada:
29+
30+
## Manual Setup
31+
732
This section will help you build a basic VuePress documentation site from ground up. If you already have an existing project and would like to keep documentation inside the project, start from Step 3.
833

934
1. Create and change into a new directory
@@ -20,8 +45,6 @@ This section will help you build a basic VuePress documentation site from ground
2045

2146
3. Install VuePress locally
2247

23-
Globally installed VuePress is no longer recommended.
24-
2548
``` bash
2649
yarn add -D vuepress # npm install -D vuepress
2750
```

0 commit comments

Comments
 (0)