mirror of
https://github.com/wahyd4/vuepress.git
synced 2026-08-13 15:25:51 +10:00
48 lines
2.0 KiB
Markdown
48 lines
2.0 KiB
Markdown
<p align="center">
|
|
<a href="https://vuepress.vuejs.org/" target="_blank">
|
|
<img width="180" src="https://raw.githubusercontent.com/vuejs/vuepress/master/packages/docs/docs/.vuepress/public/hero.png" alt="logo">
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://npmcharts.com/compare/vuepress?minimal=true"><img src="https://img.shields.io/npm/dm/vuepress.svg" alt="Downloads"></a>
|
|
<a href="https://www.npmjs.com/package/vuepress"><img src="https://img.shields.io/npm/v/vuepress.svg" alt="Version"></a>
|
|
<a href="https://www.npmjs.com/package/vuepress"><img src="https://badgen.net/npm/v/vuepress/next" alt="npm next version"></a>
|
|
<a href="https://www.npmjs.com/package/vuepress"><img src="https://img.shields.io/npm/l/vuepress.svg" alt="License"></a>
|
|
<a href="https://discordapp.com/invite/HBherRA"><img src="https://img.shields.io/badge/Discord-join%20chat-738bd7.svg" alt="vuepress channel on Discord"></a>
|
|
</p>
|
|
|
|
> This is the branch for `VuePress 1.x` and docs are available at https://v1.vuepress.vuejs.org.
|
|
|
|
## Status: alpha
|
|
|
|
Certain combinations of plugins may not work properly, and things may change or break until we reach `beta` phase. Do not use in production yet unless you are adventurous.
|
|
|
|
For 0.x, it's moved to [0.x branch](https://github.com/vuejs/vuepress/tree/0.x) and still maintained, the website is: https://vuepress.vuejs.org.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
yarn add vuepress -D # Install 0.x
|
|
yarn add vuepress@next -D # Install 1.x.
|
|
```
|
|
|
|
## Showcase
|
|
|
|
Check out [Awesome Vuepress](https://github.com/ulivz/awesome-vuepress) to find awesome things related to VuePress 1.x .
|
|
|
|
## Development
|
|
|
|
> Please make sure your version of Node.js is greater than 8.
|
|
|
|
``` bash
|
|
yarn dev # serves VuePress' own docs with itself
|
|
yarn test # make sure your code change pass the test
|
|
```
|
|
|
|
If you intend to make `"substantial"` changes to VuePress or its documentation, please checkout [VuePress RFCs](./rfcs/README.md).
|
|
|
|
## License
|
|
|
|
[MIT](https://github.com/vuejs/vuepress/blob/master/LICENSE)
|