Llewellyn
/
starship
mirror of https://github.com/Llewellynvdm/starship.git
1
0
Fork 0
Code Issues Releases Activity

docs: Add docs for running the starship website locally (#552)

This commit is contained in:
Carl Summers 2019-10-18 10:00:38 -04:00 committed by Matan Kushner
parent 27fad02837
commit 097ac144f4
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.md
View File

@ -90,3 +90,23 @@ The reason for having _both_ the Dockerfile as well as the Azure Pipelines confi
Benchmarks are located in the [`benches/`](benches) directory and are written using the [Criterion](https://crates.io/crates/criterion) library.
For the time being, benchmarks aren't actively used, but we plan to integrate benchmark comparison reporting into our CI pipeline in the near future. For the time being, they can be manually run with `cargo bench`.
## Running the Documentation Website Locally
If you are contributing to the design of Starship's website, the following section will help you get started.
### Setup
After cloning the project, you can do the following to run the VuePress website on your local machine:
1. `cd` into the `/docs` directory.
2. Install the project dependencies:
```
$ npm install
```
3. Start the project in development mode:
```
$ npm run dev
```
Once setup is complete, you can refer to VuePress documentation on the actual implementation here: https://vuepress.vuejs.org/guide/.