Sha256: 428cc69308daa464fa31aa69bb472ebcf4f6c947b4e9f56499be41b600a2aa27
Contents?: true
Size: 1.52 KB
Versions: 5
Compression:
Stored size: 1.52 KB
Contents
# jekyll-polymer-magazine
A Magazine stle theme for Jekyll based on Polymer Library
## Installation
Add this line to your Jekyll site's Gemfile:
```ruby
gem "polymer-magazine"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: polymer-magazine
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install polymer-magazine
## Usage
TODO: Write usage instructions here. Describe your available layouts, includes, and/or sass.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. 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`.
You theme is setup just like a normal Jelyll 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](http://opensource.org/licenses/MIT).
Version data entries
5 entries across 5 versions & 1 rubygems