From 7c003afbf43c7d6f09bc2598bc224e9934ab1dac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81tila=20Camur=C3=A7a?= Date: Fri, 4 Oct 2019 09:59:47 -0300 Subject: [PATCH] docs: Add a README to vuepress package Fixed #1908. --- packages/vuepress/README.md | 48 +++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 packages/vuepress/README.md diff --git a/packages/vuepress/README.md b/packages/vuepress/README.md new file mode 100644 index 0000000000..325cd3b529 --- /dev/null +++ b/packages/vuepress/README.md @@ -0,0 +1,48 @@ +

+ + logo + +

+ +

+ Downloads + Version + License + vuepress channel on Discord +

+ +# 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 + +## 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 bootstrap # Install and link dependencies for this lerna repo +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)