# LinaroJekyllTheme

Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes` and your sass in `_sass`. To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!

TODO: Delete this and the text above, and describe your gem

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kylekirkby/LinaroJekyllTheme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## Development

To set up your environment to develop this theme, run `bundle install`.

Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.

## License

The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
=======
# LinaroJekyllTheme

A Jekyll theme for Linaro Static Websites.

## Installation

In order to setup up a new jekyll site with the Linaro Jekyll Theme you must do the following:

```
jekyll new NameOfYourSite
```
Look for for the default Jekyll Minima Theme include in your `_config.yml` file. Changed this:

```yaml
theme: minima
```
to this:

```yaml
theme: linaro-jekyll-theme
```

Add this line to your Jekyll site's `Gemfile`:

```ruby
gem "linaro-jekyll-theme"
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install linaro-jekyll-theme


Once you have done this make sure the theme has installed correctly by running the following command:

```
jekyll serve
```

## Theme Usage

The Linaro Jekyll Theme comes with a many features/layouts that you can use in your theme implementation to make your theme look the best it possibly can.

    1. Generated breadcrumb
    2. Responsive image and media includes.

# Images
If you are using custom images in your static site then put them in /assets/images. Your images will be included with any that are needed included with the Theme.