dan/api_docs
1
0
Fork 0
mirror of https://github.com/danbulant/api_docs synced 2026-06-20 14:51:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Formatting fixes for README

Browse source
This commit is contained in:
Marc Guyer 2015-10-06 16:48:51 -04:00
parent dc45e382ce
commit 4136f7b0f7
1 changed files with 14 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -46,24 +46,31 @@ You're going to need:
1. Fork this repository on Github. 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` 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` 3. `cd slate`
4. Initialize and start 4. Initialize and start (there are a few options for this):
* Manually:
#### Manual/local
```shell ```shell
bundle install bundle install
bundle exec middleman server bundle exec middleman server
``` ```
* Or via Docker (must install Docker first) #### Via Docker (must install Docker first)
```shell ```shell
docker build -t slate . docker build -t slate .
docker run -d -p 4567:4567 --name slate -v $(pwd)/source:/app/source 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`. You can now see the docs at http://localhost:4567. Whoa! That was fast!
* Or via Vagrant
*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 ```shell
vagrant up 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). 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).