dan/api_docs
1
0
Fork 0
mirror of https://github.com/danbulant/api_docs synced 2026-05-24 12:27:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Easy setup with Docker

Browse source
This commit is contained in:
Mehul Kar 2015-02-23 11:05:57 -08:00
parent bb5c721450
commit 10179a6613
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -49,8 +49,18 @@ You're going to need:
4. Install all dependencies: `bundle install` 4. Install all dependencies: `bundle install`
5. Start the test server: `bundle exec middleman server` 5. Start the test server: `bundle exec middleman server`
Or use the included Dockerfile! (must install Docker first)
```shell
docker build -t slate .
docker run -d -p 4567:4567 slate
```
You can now see the docs at <http://localhost:4567>. Whoa! That was fast! 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`.*
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).
Examples of Slate in the Wild Examples of Slate in the Wild