Skip to content

Commit f077f71

Browse files
Nikolaj Ivancicwaldyrious
Nikolaj Ivancic
andauthored
docs: improve getting started guide (vuejs#2710)
Co-authored-by: Waldir Pimenta <[email protected]>
1 parent f74a6ec commit f077f71

File tree

1 file changed

+29
-7
lines changed

1 file changed

+29
-7
lines changed

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

+29-7
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
- [Node.js 10+](https://nodejs.org/en/)
66
- [Yarn Classic](https://classic.yarnpkg.com/en/) (Optional)\*
77

8-
\* _If your project is using webpack 3.x, you may notice some installation issues with npm. In this case, we recommend using Yarn._
8+
\* _If your project is using webpack 3.x, you may notice some installation issues with `npm`. In this case, we recommend using Yarn._
99

1010
## Quick Start
1111

12-
The fastest way to get your VuePress project setup is to use our [create-vuepress-site generator](https://github.com/vuepressjs/create-vuepress-site/) which will help scaffold the basic VuePress site structure for you.
12+
The fastest way to get your VuePress project set up is to use our [create-vuepress-site generator](https://github.com/vuepressjs/create-vuepress-site/), which will help scaffold the basic VuePress site structure for you.
1313

1414
To use it, open up your terminal in the desired directory and run the following command:
1515

@@ -27,19 +27,41 @@ npx create-vuepress-site [optionalDirectoryName]
2727
</code-block>
2828
</code-group>
2929

30-
You will then have the opportunity to configure your VuePress site’s metadata such as:
30+
The command will interactively ask for details to configure your VuePress site’s metadata such as:
3131

3232
- Project Name
3333
- Description
3434
- Maintainer Email
3535
- Maintainer Name
3636
- Repository URL
3737

38-
Once it is complete, you should see your new VuePress site scaffolded in your directory! :tada:
38+
Once this done, a scaffolded documentation site will be created in the `docs` directory (or custom directory name, if passed) under the current directory.
39+
40+
To see it in action, navigate into newly scaffolded directory, install the dependencies and start the local server:
41+
42+
<code-group>
43+
<code-block title="YARN" active>
44+
```bash
45+
cd docs
46+
yarn install
47+
yarn dev
48+
```
49+
</code-block>
50+
51+
<code-block title="NPM">
52+
```bash
53+
cd docs
54+
npm install
55+
npm run dev
56+
```
57+
</code-block>
58+
</code-group>
3959

4060
## Manual Installation
4161

42-
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.
62+
If you prefer, you can build a basic VuePress documentation site from ground up instead of using the generator mentioned above.
63+
64+
Note: If you already have an existing project and would like to keep documentation inside the project, start from Step 3.
4365

4466
1. Create and change into a new directory
4567

@@ -85,9 +107,9 @@ This section will help you build a basic VuePress documentation site from ground
85107
mkdir docs && echo '# Hello VuePress' > docs/README.md
86108
```
87109

88-
5. Add some [scripts](https://classic.yarnpkg.com/en/docs/package-json#toc-scripts) to `package.json`
110+
5. Add helper [scripts](https://classic.yarnpkg.com/en/docs/package-json#toc-scripts) to `package.json`
89111

90-
This step is optional but highly recommended, the rest of the documentation will assume those scripts being added.
112+
This step is optional but highly recommended, as the rest of the documentation will assume those scripts being present.
91113

92114
```json
93115
{

0 commit comments

Comments
 (0)