41 lines
1.2 KiB
Plaintext
41 lines
1.2 KiB
Plaintext
# <%= 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.
|
||
|
||
## License
|
||
|
||
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
||
|