From 4136f7b0f795e091c0e793e3b7d7580e7c7f465d Mon Sep 17 00:00:00 2001 From: Marc Guyer Date: Tue, 6 Oct 2015 16:48:51 -0400 Subject: [PATCH] Formatting fixes for README --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b2e4105..9384a57 100644 --- a/README.md +++ b/README.md @@ -46,24 +46,31 @@ You're going to need: 1. Fork this repository on Github. 2. Clone *your forked repository* (not our original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/slate.git` 3. `cd slate` -4. Initialize and start - * Manually: +4. Initialize and start (there are a few options for this): + +#### Manual/local + ```shell bundle install bundle exec middleman server ``` - * Or via Docker (must install Docker first) +#### Via Docker (must install Docker first) + ```shell docker build -t slate . docker run -d -p 4567:4567 --name slate -v $(pwd)/source:/app/source slate ``` - You can now see the docs at http://localhost:4567. Whoa! That was fast! Note: if you're using the Docker setup on OSX, the docs will be - availalable at the output of `boot2docker ip` instead of `localhost:4567`. - * Or via Vagrant + +You can now see the docs at http://localhost:4567. Whoa! That was fast! + +*Note: if you're using the Docker setup on OSX, the docs will be availalable at the output of `boot2docker ip` instead of `localhost:4567`.* + +#### Via Vagrant ```shell vagrant up ``` - You can now see the docs at http://localhost:4567. + +You can now see the docs at http://localhost:4567. Now that Slate is all set up your machine, you'll probably want to learn more about [editing Slate markdown](https://github.com/tripit/slate/wiki/Markdown-Syntax), or [how to publish your docs](https://github.com/tripit/slate/wiki/Deploying-Slate).