You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<ahref="https://npmcharts.com/compare/vuepress?minimal=true"><ahref="https://opencollective.com/vuepress"alt="Financial Contributors on Open Collective"><imgsrc="https://opencollective.com/vuepress/all/badge.svg?label=financial+contributors" /></a> <imgsrc="https://img.shields.io/npm/dm/vuepress.svg"alt="Downloads"></a>
<ahref="https://discordapp.com/invite/HBherRA"><imgsrc="https://img.shields.io/badge/Discord-join%20chat-738bd7.svg"alt="vuepress channel on Discord"></a>
12
+
</p>
13
+
14
+
# Vuepress
15
+
16
+
:memo: Minimalistic Vue-powered static site generator
17
+
18
+
## Installation
19
+
20
+
Use the package manager [yarn](https://yarnpkg.com/) to install vuepress as a dev dependency.
21
+
22
+
```bash
23
+
yarn add vuepress -D
24
+
```
25
+
26
+
## Documentation
27
+
28
+
The docs are available at <https://vuepress.vuejs.org>
29
+
30
+
## Contributing
31
+
32
+
Want to contribute? Check our [issues for beginners](https://github.com/vuejs/vuepress/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)!
33
+
34
+
```bash
35
+
yarn bootstrap # Install and link dependencies for this lerna repo
36
+
yarn dev # serves VuePress' own docs with itself
37
+
yarn test# make sure your code change pass the test
38
+
```
39
+
40
+
If you don't have a local checkout, you can also open [VuePress in Gitpod](https://gitpod.io/#https://github.com/vuejs/vuepress/blob/master/packages/docs/docs/README.md), a free online IDE for GitHub.
41
+
42
+
If you intend to make `"substantial"` changes to VuePress or its documentation, please checkout [VuePress RFCs](./rfcs/README.md).
43
+
44
+
If you have a VuePress-related project/component/tool, add it with a pull request to [this curated list](https://github.com/ulivz/awesome-vuepress)!
0 commit comments