From faeb3b0420ba65f26fc7983e418d31a3e7c9b813 Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Sun, 17 Jan 2021 15:58:08 +0000 Subject: [PATCH 1/2] Clarify some steps in the getting started guide --- packages/docs/docs/guide/getting-started.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/packages/docs/docs/guide/getting-started.md b/packages/docs/docs/guide/getting-started.md index e2fcd4c756..7eaf59b271 100644 --- a/packages/docs/docs/guide/getting-started.md +++ b/packages/docs/docs/guide/getting-started.md @@ -5,11 +5,11 @@ - [Node.js 10+](https://nodejs.org/en/) - [Yarn Classic](https://classic.yarnpkg.com/en/) (Optional)\* -\* _If your project is using webpack 3.x, you may notice some installation issues with npm. In this case, we recommend using Yarn._ +\* _If your project is using webpack 3.x, you may notice some installation issues with `npm`. In this case, we recommend using Yarn._ ## Quick Start -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. +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. To use it, open up your terminal in the desired directory and run the following command: @@ -27,7 +27,7 @@ npx create-vuepress-site [optionalDirectoryName] -You will then have the opportunity to configure your VuePress site’s metadata such as: +The command will interactively ask for details to configure your VuePress site’s metadata such as: - Project Name - Description @@ -39,7 +39,9 @@ Once it is complete, you should see your new VuePress site scaffolded in your di ## Manual Installation -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. +If you prefer, you can build a basic VuePress documentation site from ground up instead of using the generator mentioned above. + +Note: If you already have an existing project and would like to keep documentation inside the project, start from Step 3. 1. Create and change into a new directory @@ -85,9 +87,9 @@ This section will help you build a basic VuePress documentation site from ground mkdir docs && echo '# Hello VuePress' > docs/README.md ``` -5. Add some [scripts](https://classic.yarnpkg.com/en/docs/package-json#toc-scripts) to `package.json` +5. Add helper [scripts](https://classic.yarnpkg.com/en/docs/package-json#toc-scripts) to `package.json` - This step is optional but highly recommended, the rest of the documentation will assume those scripts being added. + This step is optional but highly recommended, as the rest of the documentation will assume those scripts being present. ```json { From d2705d3d2c22f9dc374699631a855dcd77501a50 Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Sun, 17 Jan 2021 15:58:52 +0000 Subject: [PATCH 2/2] Getting Started: Complete the Quick Start section --- packages/docs/docs/guide/getting-started.md | 22 ++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/packages/docs/docs/guide/getting-started.md b/packages/docs/docs/guide/getting-started.md index 7eaf59b271..27f2e69bd4 100644 --- a/packages/docs/docs/guide/getting-started.md +++ b/packages/docs/docs/guide/getting-started.md @@ -35,7 +35,27 @@ The command will interactively ask for details to configure your VuePress site - Maintainer Name - Repository URL -Once it is complete, you should see your new VuePress site scaffolded in your directory! :tada: +Once this done, a scaffolded documentation site will be created in the `docs` directory (or custom directory name, if passed) under the current directory. + +To see it in action, navigate into newly scaffolded directory, install the dependencies and start the local server: + + + +```bash +cd docs +yarn install +yarn dev +``` + + + +```bash +cd docs +npm install +npm run dev +``` + + ## Manual Installation