Readme.md

# HCI Theme

The HCI Theme packaged as a gem.


## Installation

Add these lines to your Jekyll site's `Gemfile`:

```ruby
gem "hci-theme", :git => "git@gitlab2.informatik.uni-wuerzburg.de:hci-development/hci-theme.git"
gem "jekyll-img-srcset", :git => "git@gitlab2.informatik.uni-wuerzburg.de:hci-development/jekyll-img-srcset.git"
```

And add these lines to your Jekyll site's `_config.yml`:

```yaml
theme: hci-theme
plugins:
  - jekyll-img-srcset
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install hci-theme

## Usage

### Menu
The menu is configured in the `_config.yml` file as.

```yaml
menu:
  - title: "Home"
    href: "/"
    items:
      - title: "Other"
        href: "/other"
```

### Image Carousel
The teaser images at the top can be selected for each page individually with a default in the `_config.yml` as:

```yaml
slides:
  - general/bbb-demo.jpg
```

### Image Resizing
Images get resized to provide lower resulutions for mobile devices. Select which widths to generate in the `_config.yml` with:

```yaml
widths:
  - 1688
  - 1208
  - 844
  - 640
  - 320
```