From 741f78083389f5d7569d92dffb547c5833f2f65e Mon Sep 17 00:00:00 2001 From: Ben Hong Date: Tue, 18 Aug 2020 08:36:26 -0400 Subject: [PATCH 1/8] docs: bring user straight to the guide --- packages/docs/docs/README.md | 23 ----------------------- 1 file changed, 23 deletions(-) diff --git a/packages/docs/docs/README.md b/packages/docs/docs/README.md index a381cbca85..b0d27fba26 100644 --- a/packages/docs/docs/README.md +++ b/packages/docs/docs/README.md @@ -24,26 +24,3 @@ footer: MIT Licensed | Copyright © 2018-present Evan You

VuePress generates pre-rendered static HTML for each page, and runs as an SPA once a page is loaded.

- -### As Easy as 1, 2, 3 - -``` bash -# Scaffold VuePress site -yarn create vuepress [directoryName] -# OR npx create-vuepress [directoryName] - -# Navigate to your new VuePress directory -cd [directoryName] - -# Start local dev server -yarn dev -# OR npm run dev - -# Build static files -yarn build -# OR npm run build -``` - -::: warning COMPATIBILITY NOTE -VuePress requires Node.js >= 8.6. -::: From 49473bccdddd23966faf81764bfccd30dc85f017 Mon Sep 17 00:00:00 2001 From: Ben Hong Date: Tue, 18 Aug 2020 08:37:14 -0400 Subject: [PATCH 2/8] docs: use index instead of README --- packages/docs/docs/{README.md => index.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename packages/docs/docs/{README.md => index.md} (100%) diff --git a/packages/docs/docs/README.md b/packages/docs/docs/index.md similarity index 100% rename from packages/docs/docs/README.md rename to packages/docs/docs/index.md From 9ef6d61aa4542b58360a7d0600cf5f8a4d55f46a Mon Sep 17 00:00:00 2001 From: Ben Hong Date: Tue, 18 Aug 2020 08:37:59 -0400 Subject: [PATCH 3/8] docs: update CTA to go to get started guide --- packages/docs/docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/docs/index.md b/packages/docs/docs/index.md index b0d27fba26..dfd22bd56b 100644 --- a/packages/docs/docs/index.md +++ b/packages/docs/docs/index.md @@ -2,7 +2,7 @@ home: true heroImage: /hero.png actionText: Get Started → -actionLink: /guide/ +actionLink: /guide/getting-started.html footer: MIT Licensed | Copyright © 2018-present Evan You --- From dd443f7d6a159a2f52ef5266e6204e0f3a7d0f2d Mon Sep 17 00:00:00 2001 From: Ben Hong Date: Tue, 18 Aug 2020 08:49:09 -0400 Subject: [PATCH 4/8] docs: add update step for generator and remove older warnings --- packages/docs/docs/guide/getting-started.md | 37 ++++++++++++--------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/packages/docs/docs/guide/getting-started.md b/packages/docs/docs/guide/getting-started.md index 8ef1fe7be8..0eba855c99 100644 --- a/packages/docs/docs/guide/getting-started.md +++ b/packages/docs/docs/guide/getting-started.md @@ -1,12 +1,13 @@ # Getting Started -::: warning Prerequisite -VuePress requires [Node.js](https://nodejs.org/en/) >= 8.6. -::: +## Prerequisites + +- [Node.js](https://nodejs.org/en/) >= 8.6. +- [Yarn Classic](https://classic.yarnpkg.com/en/) (Optional) ## Quick Start -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. +The fastest way to get your VuePress project setup is to use our [create-vuepress tool](https://github.com/vuepressjs/create-vuepress/pulls) 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,35 +28,41 @@ You will then have the opportunity to configure your VuePress site’s metadata Once it is complete, you should see your new VuePress site scaffolded in your directory! :tada: -## Manual Setup +At this time, you'll need to take one more step and update the VuePress version inside the generated project. + +```bash +# Navigate into your newly created project +cd [directoryName] + +# Update VuePress dependency +yarn add -D vuepress # npm install --save-dev vuepress +``` + +## 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. 1. Create and change into a new directory - ``` bash + ```bash mkdir vuepress-starter && cd vuepress-starter ``` 2. Initialize with your preferred package manager - ``` bash + ```bash yarn init # npm init ``` 3. Install VuePress locally - ``` bash + ```bash yarn add -D vuepress # npm install -D vuepress ``` - ::: warning - We currently recommend using [Yarn](https://classic.yarnpkg.com/lang/en/) instead of npm when installing VuePress into an existing project that has webpack 3.x as a dependency, because npm fails to generate the correct dependency tree in this case. - ::: - 4. Create your first document - ``` bash + ```bash mkdir docs && echo '# Hello VuePress' > docs/README.md ``` @@ -63,7 +70,7 @@ This section will help you build a basic VuePress documentation site from ground This step is optional but highly recommended, the rest of the documentation will assume those scripts being added. - ``` json + ```json { "scripts": { "docs:dev": "vuepress dev docs", @@ -74,7 +81,7 @@ This section will help you build a basic VuePress documentation site from ground 6. Serve the documentation site in the local server - ``` bash + ```bash yarn docs:dev # npm run docs:dev ``` From 8c7aaca8decb864e0bf29fc7d080474ca1afc8b6 Mon Sep 17 00:00:00 2001 From: Ben Hong Date: Tue, 18 Aug 2020 08:51:13 -0400 Subject: [PATCH 5/8] docs: add warning for webpack 3 with less prominence --- packages/docs/docs/guide/getting-started.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/docs/docs/guide/getting-started.md b/packages/docs/docs/guide/getting-started.md index 0eba855c99..0dfb5c4261 100644 --- a/packages/docs/docs/guide/getting-started.md +++ b/packages/docs/docs/guide/getting-started.md @@ -3,7 +3,9 @@ ## Prerequisites - [Node.js](https://nodejs.org/en/) >= 8.6. -- [Yarn Classic](https://classic.yarnpkg.com/en/) (Optional) +- [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._ ## Quick Start From 710fd947d9ebeb07dff1bb696023ebdaeb19792f Mon Sep 17 00:00:00 2001 From: Ben Hong Date: Tue, 18 Aug 2020 10:07:52 -0400 Subject: [PATCH 6/8] docs: update node prerequisite version --- packages/docs/docs/guide/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/docs/guide/getting-started.md b/packages/docs/docs/guide/getting-started.md index 0dfb5c4261..2e256c825c 100644 --- a/packages/docs/docs/guide/getting-started.md +++ b/packages/docs/docs/guide/getting-started.md @@ -2,7 +2,7 @@ ## Prerequisites -- [Node.js](https://nodejs.org/en/) >= 8.6. +- [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._ From ba8a7e827c92d0448bf6e643bda32fa9388b584e Mon Sep 17 00:00:00 2001 From: Ben Hong Date: Tue, 18 Aug 2020 10:08:17 -0400 Subject: [PATCH 7/8] docs: fix link for create-vuepress --- packages/docs/docs/guide/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docs/docs/guide/getting-started.md b/packages/docs/docs/guide/getting-started.md index 2e256c825c..b46dd0fd6f 100644 --- a/packages/docs/docs/guide/getting-started.md +++ b/packages/docs/docs/guide/getting-started.md @@ -9,7 +9,7 @@ ## Quick Start -The fastest way to get your VuePress project setup is to use our [create-vuepress tool](https://github.com/vuepressjs/create-vuepress/pulls) which will help scaffold the basic VuePress site structure for you. +The fastest way to get your VuePress project setup is to use our [create-vuepress tool](https://github.com/vuepressjs/create-vuepress/) 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: From 2ec19325dfe2cb846b81a14089a47fba11544e0b Mon Sep 17 00:00:00 2001 From: Ben Hong Date: Sat, 22 Aug 2020 09:05:38 -0400 Subject: [PATCH 8/8] docs: remove upgrade step --- packages/docs/docs/guide/getting-started.md | 18 +++--------------- 1 file changed, 3 insertions(+), 15 deletions(-) diff --git a/packages/docs/docs/guide/getting-started.md b/packages/docs/docs/guide/getting-started.md index b46dd0fd6f..8b839378ff 100644 --- a/packages/docs/docs/guide/getting-started.md +++ b/packages/docs/docs/guide/getting-started.md @@ -9,17 +9,15 @@ ## Quick Start -The fastest way to get your VuePress project setup is to use our [create-vuepress tool](https://github.com/vuepressjs/create-vuepress/) which will help scaffold the basic VuePress site structure for you. +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. To use it, open up your terminal in the desired directory and run the following command: ```bash -yarn create vuepress [directoryName] -# OR npx create-vuepress [directoryName] +yarn create vuepress-site [optionalDirectoryName] +# OR npx create-vuepress-site [optionalDirectoryName] ``` -You will be prompted to choose which boilerplate you prefer. For most users, the `docs` boilerplate is what you will want. - You will then have the opportunity to configure your VuePress site’s metadata such as: - Project Name @@ -30,16 +28,6 @@ You will then have the opportunity to configure your VuePress site’s metadata Once it is complete, you should see your new VuePress site scaffolded in your directory! :tada: -At this time, you'll need to take one more step and update the VuePress version inside the generated project. - -```bash -# Navigate into your newly created project -cd [directoryName] - -# Update VuePress dependency -yarn add -D vuepress # npm install --save-dev vuepress -``` - ## 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.