jekyll/lib/theme_template
Parker Moore 12deccc513
Only spec.summary is needed...
2016-05-19 14:39:55 -07:00
..
example Add a Rakefile to do releases as well as adding an example website. 2016-05-19 14:36:01 -07:00
CODE_OF_CONDUCT.md.erb Add CoC and README for theme; make standard with Rubocop 2016-05-16 11:06:47 -07:00
Gemfile Add more template files and add a ThemeBuilder which can create the site 2016-05-16 10:53:55 -07:00
LICENSE.txt.erb Add more template files and add a ThemeBuilder which can create the site 2016-05-16 10:53:55 -07:00
README.md.erb Add a Rakefile to do releases as well as adding an example website. 2016-05-19 14:36:01 -07:00
Rakefile.erb Add a Rakefile to do releases as well as adding an example website. 2016-05-19 14:36:01 -07:00
theme.gemspec.erb Only spec.summary is needed... 2016-05-19 14:39:55 -07:00

README.md.erb

# <%= theme_name %>

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

## Installation

Add this line to your Jekyll site's Gemfile:

```ruby
gem <%= theme_name.inspect %>
```

And add this line to your Jekyll site:

```yaml
theme: <%= theme_name %>
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install <%= theme_name %>

## 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`.

To test your theme, run `bundle exec rake preview` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme and the contents of the `example/` directory. As you make modifications to your theme and to the example site, your site will regenerate and you should see the changes in the browser after a refresh.

## License

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