open-vault/website
RJ Spiker e1bff4b447 website: adjust button-container behavior based on design feedback (#5613) 2018-10-25 14:25:51 -07:00
..
assets website: adjust button-container behavior based on design feedback (#5613) 2018-10-25 14:25:51 -07:00
data Update docs_detailed_categories.yml 2018-10-23 14:01:48 -07:00
deploy fix github repo reference (#5555) 2018-10-19 09:54:56 -07:00
source Update docs and permissions (#5612) 2018-10-25 14:10:11 -07:00
Gemfile New Docs Website (#5535) 2018-10-19 08:40:11 -07:00
Gemfile.lock New Docs Website (#5535) 2018-10-19 08:40:11 -07:00
LICENSE.md Update license 2017-03-08 11:38:38 -08:00
Makefile website: Fix makefile commands to quote command (#5559) 2018-10-19 11:46:36 -07:00
README.md New Docs Website (#5535) 2018-10-19 08:40:11 -07:00
bootstrap.sh New Docs Website (#5535) 2018-10-19 08:40:11 -07:00
config.rb website: change production env var to workaround Dato bug 2018-10-24 13:52:49 -06:00
redirects.txt New Docs Website (#5535) 2018-10-19 08:40:11 -07:00

README.md

Vault Website

This subdirectory contains the entire source for the Vault Website. This is a Middleman project, which builds a static site from these source files.

Contributions Welcome!

If you find a typo or you feel like you can improve the HTML, CSS, or JavaScript, we welcome contributions. Feel free to open issues or pull requests like any normal GitHub project, and we'll merge it in.

Running the Site Locally

Running the site locally is simple. Clone this repo and run make website. If it is your first time running the site, the build will take a little longer as it needs to download a docker image and a bunch of dependencies, so maybe go grab a coffee. On subsequent runs, it will be much faster as dependencies are cached.

Then open up http://localhost:4567. Note that some URLs you may need to append ".html" to make them work (in the navigation).