Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/terenceponce/jekyll-theme-eventually
Jekyll integration of Eventually theme by HTML5 UP
https://github.com/terenceponce/jekyll-theme-eventually
jekyll jekyll-plugin jekyll-theme
Last synced: about 2 months ago
JSON representation
Jekyll integration of Eventually theme by HTML5 UP
- Host: GitHub
- URL: https://github.com/terenceponce/jekyll-theme-eventually
- Owner: terenceponce
- License: mit
- Created: 2018-08-09T07:29:56.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-08-10T15:29:56.000Z (over 6 years ago)
- Last Synced: 2024-04-25T14:44:03.745Z (9 months ago)
- Topics: jekyll, jekyll-plugin, jekyll-theme
- Language: CSS
- Size: 1020 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# jekyll-theme-eventually
Jekyll integration of [Eventually theme](https://html5up.net/eventually) by [HTML5 UP](https://html5up.net/).
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "jekyll-theme-eventually"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: jekyll-theme-eventually
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-theme-eventually
## Usage
### Enabling MailChimp
This Jekyll theme supports [MailChimp](https://mailchimp.com).
In order to use this, you must provide your User ID and List ID from MailChimp inside `_config.yml`:
```
mailchimp_userid: abcd123
mailchimp_listid: abcd123
```
### Enabling Google Analytics
To enable Google Analytics, add the following lines to your `_config.yml`:
```
google_analytics: UA-NNNNNNNN-N
```
Google Analytics will only appear in production, i.e., `JEKYLL_ENV=production`.
### Jekyll SEO
This theme supports [Jekyll SEO](https://jekyll.github.io/jekyll-seo-tag).
For instructions on how to use this plugin, go to their [Usage Guide](https://jekyll.github.io/jekyll-seo-tag/usage/).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/terenceponce/jekyll-theme-eventually. 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`.
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 `jekyll-theme-eventually.gemspec` accordingly.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).