gocd.github.io's Introduction

www.go.cd

This repository hosts code for the website at gocd.github.io which resolves to www.go.cd. The URL go.cd redirects to www.go.cd. We're using Jekyll to generate website.

Installation

gem install jekyll

More help on installation visit http://jekyllrb.com/docs/installation/

For Windows, you have to set pygments to false in the _config.yml file

Launching website locally

jekyll serve --watch

Local website can be accessed at http://localhost:4000

Configuration

_config.yml takes care of general configuration and navigation part.

Navigation Structure

root: 'Root Text'
├── url: 'Root Link'
├── icon: 'icon class name'
├── first-level:
    ├── - text: 'First Level Text1'
      ├── url: 'First Level Link1'
      ├── second-level:
        ├── - text: 'Second Level Text1'
        ├──   url: 'Second Level Link1'

Note: when editing _config.yml, you need to restart jekyll to see the changes._

Contributing

We encourage you to contribute to Go. For information on contributing to this project, please see our contributor's guide. A lot of useful information like links to user documentation, design documentation, mailing lists etc. can be found in the resources section.

License

Copyright 2015 ThoughtWorks, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Recommend Projects