mirror of https://github.com/vuejs/vitepress
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
47 lines
1017 B
47 lines
1017 B
4 years ago
|
# 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.
|
||
|
|
|
||
|
|
- **Step. 1:** Create and change into a new directory.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ mkdir vitepress-starter && cd vitepress-starter
|
||
|
|
```
|
||
|
|
|
||
|
|
- **Step. 2:** Initialize with your preferred package manager.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ yarn init
|
||
|
|
```
|
||
|
|
|
||
|
|
- **Step. 3:** Install VuePress locally.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ yarn add --dev vitepress
|
||
|
|
```
|
||
|
|
|
||
|
|
- **Step. 4:** Create your first document.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ mkdir docs && echo '# Hello VitePress' > docs/index.md
|
||
|
|
```
|
||
|
|
|
||
|
|
- **Step. 5:** Add some scripts to `package.json`.
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"scripts": {
|
||
|
|
"docs:dev": "vitepress dev docs",
|
||
|
|
"docs:build": "vitepress build docs"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
- **Step. 6:** Serve the documentation site in the local server.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ yarn docs:dev
|
||
|
|
```
|
||
|
|
|
||
|
|
VitePress will start a hot-reloading development server at http://localhost:3000.
|