49 lines
2.2 KiB
Markdown
49 lines
2.2 KiB
Markdown
|
<p align="center">
|
||
|
|
<a href="https://vuepress.vuejs.org/" target="_blank" rel="noopener noreferrer">
|
||
|
|
<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"><a href="https://opencollective.com/vuepress" alt="Financial Contributors on Open Collective"><img src="https://opencollective.com/vuepress/all/badge.svg?label=financial+contributors" /></a> <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://github.com/vuejs/vuepress/blob/master/LICENSE"><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>
|
||
|
|
|
||
|
|
# VuePress
|
||
|
|
|
||
|
|
:memo: Minimalistic Vue-powered static site generator
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
Use the package manager [yarn](https://yarnpkg.com/) to install VuePress as a dev dependency.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
yarn add vuepress -D
|
||
|
|
```
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
The docs are available at <https://vuepress.vuejs.org>
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
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)!
|
||
|
|
|
||
|
|
```bash
|
||
|
|
yarn # Install and link dependencies for this monorepo
|
||
|
|
yarn dev # serves VuePress' own docs with itself
|
||
|
|
yarn test # make sure your code change pass the test
|
||
|
|
```
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
If you intend to make `"substantial"` changes to VuePress or its documentation, please checkout [VuePress RFCs](./rfcs/README.md).
|
||
|
|
|
||
|
|
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)!
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
[MIT](https://github.com/vuejs/vuepress/blob/master/LICENSE)
|