Skip to content
This repository was archived by the owner on May 13, 2024. It is now read-only.

Commit fbe49d4

Browse files
committed
docs: add warning to quick start
1 parent 2e96314 commit fbe49d4

File tree

1 file changed

+46
-36
lines changed

1 file changed

+46
-36
lines changed

docs/README.md

Lines changed: 46 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -12,42 +12,7 @@ next: /config/
1212
1313
You must distinguish between [official blog plugin](https://vuepress-plugin-blog.ulivz.com/) and this theme. Both of them are maintained by [VuePress](https://vuepress.vuejs.org/). We try to implement all the common and necessary blog features in the plugin, and pay more attention to the interactive experience in the theme. So, the plugin might be reused in several blog themes, and this theme is one of them.
1414

15-
## Quick Start
16-
17-
To make it easier to get started, you can use [create-vuepress](https://github.com/vuepressjs/create-vuepress) which is indeed an npm package, but it doesn’t mean you need to install it manually first. Here's an example:
18-
19-
Step 1: Scaffolding out a VuePress blog
20-
```bash
21-
yarn create vuepress [blogName]
22-
23-
# And answer the following questions in CLI, for instance:
24-
25-
# ? Select the boilerplate type blog
26-
27-
# ? What's the name of your project? blog
28-
29-
# ? What's the description of your project? Billyyyyy3320's personal website
30-
31-
# ? What's your email? newsbielt703@gmail.com
32-
33-
# ? What's your name? Billy Chin
3415

35-
# ? What's the repo of your project. https://github.com/newsbielt703/Billy
36-
37-
cd [blogName] && yarn
38-
```
39-
40-
Step 2: Develop & Build
41-
42-
```bash
43-
# Run localhost
44-
yarn dev
45-
46-
# Build your VP blog
47-
yarn build
48-
```
49-
50-
By default, VuePress dev server is listening at `http://localhost:8080/`, whereas the built files will be in `.vuepress/dist`.
5116

5217
## Getting Started from scratch
5318

@@ -172,7 +137,52 @@ location: Taipei
172137
---
173138
```
174139

175-
### Final
140+
## Quick Start
141+
142+
To make it easier to get started, you can use [create-vuepress](https://github.com/vuepressjs/create-vuepress) which is indeed an npm package, but it doesn’t mean you need to install it manually first. Here's an example:
143+
144+
Step 1: Scaffolding out a VuePress blog
145+
```bash
146+
yarn create vuepress [blogName]
147+
148+
# And answer the following questions in CLI, for instance:
149+
150+
# ? Select the boilerplate type blog
151+
152+
# ? What's the name of your project? blog
153+
154+
# ? What's the description of your project? Billyyyyy3320's personal website
155+
156+
# ? What's your email? newsbielt703@gmail.com
157+
158+
# ? What's your name? Billy Chin
159+
160+
# ? What's the repo of your project. https://github.com/newsbielt703/Billy
161+
162+
cd [blogName] && yarn
163+
```
164+
165+
Step 2: Develop & Build
166+
167+
```bash
168+
# Run localhost
169+
yarn dev
170+
171+
# Build your VP blog
172+
yarn build
173+
```
174+
175+
By default, VuePress dev server is listening at `http://localhost:8080/`, whereas the built files will be in `.vuepress/dist`.
176+
177+
:::warning
178+
Currently, [create-vuepress](https://github.com/vuepressjs/create-vuepress) won't install the latest version of `@vuepress/theme-blog`, you have to update it manually by running `yarn add @vuepress/theme-blog -D`.
179+
180+
Beware that we have made some breaking changes in v2.0, you also have to make some changes manually. here's the changelog.
181+
182+
However, it's still a convenient tool to help you scaffold out a new project with a set of predefined templates.
183+
:::
184+
185+
## Final
176186

177187
Now, Check out your blog at `localhost:8080`, if everything is ok, you might be interested in the following topics:
178188

0 commit comments

Comments
 (0)