Public Repository

Last pushed: 4 days ago
Short Description
Easily run and compile the Codeship Documentation.
Full Description

Codeship Documentation

Getting Started


The first step is cloning and going into the repository.

git clone
cd documentation

Then build the container and save it as a tagged image.

docker build --tag codeship/documentation .

You can now run commands via that container. By default, it will build the site and start the Jekyll development server.

docker run -it --rm -p 4000:4000 -v $(pwd):/docs codeship/documentation

To access the site open http://IP_OF_YOUR_DOCKER_SERVER:4000 in your browser. Usually, this is localhost:4000.

On Windows, the Docker commands are executed via the Docker Quickstart Terminal. If localhost doesn't work, you might have to open a normal command prompt and type docker-machine ls. There you can take the IP that is listed under URL and type the IP (with port 4000) into your browser to reach the documentation.


Updating dependencies

To update Rubygem based dependencies, update the Gemfile (if required) and run

docker run -it --rm -v $(pwd):/docs codeship/documentation bundle update

For NPM based dependencies, run the following two commands

docker run -it --rm -v $(pwd):/docs codeship/documentation yarn upgrade



SCSS files are automatically linted using scss-lint. To run it, execute the following command

docker run -it --rm -v $(pwd):/docs codeship/documentation bundle exec scss-lint

It's configured in .scss-lint.yml and the default configuration is available online as well.


docker run -it --rm -v $(pwd):/docs codeship/documentation gulp lint


docker run -it --rm -v $(pwd):/docs codeship/documentation bundle exec jekyll doctor
Docker Pull Command