diff --git a/docs/guide/deploy.md b/docs/guide/deploy.md index 6977ffe6..2119f0aa 100644 --- a/docs/guide/deploy.md +++ b/docs/guide/deploy.md @@ -4,13 +4,13 @@ The following guides are based on some shared assumptions: - You are placing your docs inside the `docs` directory of your project; - You are using the default build output location (`.vitepress/dist`); -- VuePress is installed as a local dependency in your project, and you have setup the following npm scripts: +- VitePress is installed as a local dependency in your project, and you have setup the following npm scripts: ```json { "scripts": { - "docs:build": "vuepress build docs", - "docs:serve": "vuepress serve docs" + "docs:build": "vitepress build docs", + "docs:serve": "vitepress serve docs" } } ``` @@ -41,7 +41,7 @@ You may configure the port of the server py passing `--port` flag as an argument ```json { "scripts": { - "docs:serve": "vuepress serve docs --port 8080" + "docs:serve": "vitepress serve docs --port 8080" } } ``` diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index 1bc4a3e7..8436901e 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -1,6 +1,6 @@ # Getting Started -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. +This section will help you build a basic VitePress 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. - **Step. 1:** Create and change into a new directory. @@ -14,7 +14,7 @@ This section will help you build a basic VuePress documentation site from ground $ yarn init ``` -- **Step. 3:** Install VuePress locally. +- **Step. 3:** Install VitePress locally. ```bash $ yarn add --dev vitepress @@ -46,6 +46,6 @@ This section will help you build a basic VuePress documentation site from ground VitePress will start a hot-reloading development server at http://localhost:3000. -By now, you should have a basic but functional VuePress documentation site. +By now, you should have a basic but functional VitePress documentation site. When your documentation site starts to take shape, be sure to read the [deployment guide](./deploy).