Codeship Documentation

Contributing

See our contributing guidelines and our code of conduct

Getting Started

Setup

Clone the repository, install needed gems and run Jekyll ;)

git clone git@github.com:codeship/documentation.git
cd documentation
bundle install
bundle exec jekyll serve

You can then access the site at http://localhost:4000

Linting

SCSS

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

bundle exec scss-lint

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

Markup

If you want to include a table of contents, include the following snippet in the markdown file

* include a table of contents
{:toc}

URL Helpers

Tags

Generate a URL for the specified tag (database in the example below). This is also available as a filter to be used with a variable (tag in the example).

{% tag_url databases %}
{{ tag | tag_url }}

generate the output like the following (depending on configuration values)

/tags/databases/

Man Pages

Link to a specific Ubuntu man page. This currently defaults to the Ubuntu Trusty version.

{% man_url formatdb %}

generates the following output

http://manpages.ubuntu.com/manpages/trusty/en/man1/formatdb.1.html

keimlink/documentation