Bestow Quote Widget Documentation Site

Runs as a forked repo of Slate: https://github.com/lord/slate

Prerequisites

You're going to need:

• Linux or macOS — Windows may work, but is unsupported.
• Ruby, version 2.3.1 or newer - brew install ruby
• Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Getting Set Up

1. Clone to your hard drive with git clone [email protected]:Bestowinc/quote-widget-docs.git
2. cd quote-widget-docs
3. Initialize and start. You can either do this locally, or with Vagrant:

# either run this to run locally
bundle install
bundle exec middleman server

# OR run this to run with vagrant
vagrant up

You can now see the docs at http://localhost:4567. Whoa! That was fast!

Now that Slate is all set up on your machine, you'll probably want to learn more about editing Slate markdown, or how to publish your docs.

If you'd prefer to use Docker, instructions are available in the wiki.

Deploy

Very simple

cd quote-widget-docs
./deploy.sh