Sha256: 98896099d2dd607f870449238e997be3e61ca0b5fd5460bd7f179bd6bb5400eb
Contents?: true
Size: 1.33 KB
Versions: 15
Compression:
Stored size: 1.33 KB
Contents
# shanep-class
This is a simple theme to use for a class hosted on github pages
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "shanep-class"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: shanep-class
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install shanep-class
## Usage
You can see an example at [shanep-cs2.github.io](https://github.com/shanep-cs2/shanep-cs2.github.io)
## 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 `shanep-class.gemspec` accordingly.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
Version data entries
15 entries across 15 versions & 1 rubygems