Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add deps install and dev server to quick start #2806

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add deps install and dev server to quick start #2806

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 38 additions & 0 deletions packages/docs/docs/guide/getting-started.md
View file
Open in desktop
Expand Up @@ -37,6 +37,44 @@ 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:

The scaffold creates a `<project-name>/docs` directory containing a `package.json`.

To install the package dependencies, run the following:

<code-group>
<code-block title="YARN" active>
```bash
cd <project-name>/docs
yarn install
```
</code-block>

<code-block title="NPM">
```bash
cd <project-name>/docs
npm install
```
</code-block>
</code-group>

With the dependencies installed you can now run the development server:

<code-group>
<code-block title="YARN" active>
```bash
npm run dev
```
</code-block>

<code-block title="NPM">
```bash
yarn run dev
```
</code-block>
</code-group>

Browse to http://localhost:8081 to view the live development server.

## 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.
Expand Down