README.md 1.15 KB
Newer Older
Jacek Lebioda's avatar
Jacek Lebioda committed
1 2
# elixir-theme

Jacek Lebioda's avatar
Develop  
Jacek Lebioda committed
3
## Release history
Jacek Lebioda's avatar
Jacek Lebioda committed
4

Jacek Lebioda's avatar
Develop  
Jacek Lebioda committed
5 6
### version 0.2.0
Added responsiveness
Jacek Lebioda's avatar
Jacek Lebioda committed
7

Jacek Lebioda's avatar
Develop  
Jacek Lebioda committed
8 9
### version 0.1.0
Initial theme
Jacek Lebioda's avatar
Jacek Lebioda committed
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44


## Installation

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

```ruby
gem "elixir-theme"
```

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

```yaml
theme: elixir-theme
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install elixir-theme


## 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`, `_sass` and `assets` tracked with Git will be bundled.
To add a custom directory to your theme-gem, please edit the regexp in `elixir-theme.gemspec` accordingly.

## License
Jacek Lebioda's avatar
Develop  
Jacek Lebioda committed
45
Apache2