Sha256: 804dc062293a0a1427a2d6566657897ffa8950a270684c08fd395553c186b868

Contents?: true

Size: 1004 Bytes

Versions: 6

Compression:

Stored size: 1004 Bytes

Contents

voppe-jekyll-theme
===

## Setup

Add this line to your Jekyll site's Gemfile:

```ruby
gem "voppe-jekyll-theme"
```

And add this line to your Jekyll site's `_config.yml`:

```yaml
theme: voppe-jekyll-theme
```

Execute installation:
```
    $ bundle install
```

## Usage

### Menu

Create a file `menu.yml` in your `_data` folder. The file's structure is the following

``` yaml
items:
    *menuitems*
footer:
    *menuitems*
```

Where `menuitems` is an array of items with the following structure

```yaml
*section*:
    # If not specified defaults to '/*section*/'
    link: string 
    
    # Defaults to medium
    size: medium|large

    # The text to show on item hover
    label: string

    # A fontawesome icon name (e.g. 'envelope')
    icon: string

    # A background image link
    background: string 
```

## License

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

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
voppe-jekyll-theme-0.4.0 README.md
voppe-jekyll-theme-0.3.0 README.md
voppe-jekyll-theme-0.2.4 README.md
voppe-jekyll-theme-0.2.3 README.md
voppe-jekyll-theme-0.2.2 README.md
voppe-jekyll-theme-0.2.1 README.md