From 097ac144f442a72de79c6ccec8946b64ae3590d5 Mon Sep 17 00:00:00 2001
From: Carl Summers <31711543+CSumm@users.noreply.github.com>
Date: Fri, 18 Oct 2019 10:00:38 -0400
Subject: [PATCH] docs: Add docs for running the starship website locally
 (#552)

---
 CONTRIBUTING.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index bdb8abd1..dee90d1f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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/.