README.md

docs

Documentation for Shippable's Automated DevOps platform

Using Local Installation

With Docker

$ git clone [email protected]:Shippable/docs.git shippable-docs
$ cd shippable-docs
$ ./base

Docs should be available at localhost:5555 once the base script finishes successfully.

Without Docker

To get started you have to have git and python3 with pip and virtualenv installed:

$ git clone [email protected]:Shippable/docs.git shippable-docs
$ cd shippable-docs
$ virtualenv venv
$ source venv/bin/activate
(venv)$ pip install -r requirements.txt

Server

To start documentation server at localhost:5555:

(venv)$ mkdocs serve --dev-addr=localhost:5555

This uses livereload to monitors changes to the files. Therefore as soon as you save a file, the browser is refreshed.