From 283c40d5facdb1074f82953cadcf259b6629c348 Mon Sep 17 00:00:00 2001 From: Peter Date: Wed, 17 May 2017 07:33:24 +1000 Subject: [PATCH] Add Jekyll build and run instructions (#11) * Add Jekyll build and run instructions * Add Ruby and links for each requirement --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 91247fba..d585b137 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,19 @@ # bitwarden Help Center -The bitwarden help center project is written using Jekyll, which is hosted/deployed to a GitHub pages branch. +The bitwarden help center project is written using Jekyll, which is hosted/deployed to a GitHub pages branch ([https://help.bitwarden.com/](https://help.bitwarden.com/)). + +# Build/Run +**Requirements** + +- [Pug (Ruby)](https://www.ruby-lang.org/en/) +- [Jekyll](https://jekyllrb.com/) + +Run the following commands: +- `jekyll build` +- `jekyll serve` + +You can now access the help center at `localhost:4009`. # Contribute