cooper

chrisjm

Cooper is a flexible, minimally opinionated two-column Jekyll theme.

Cooper Jekyll Theme

Cooper is a flexible, minimally opinionated two-column Jekyll theme. It works well for a personal, professional, marketing, blog, or portfolio site on GitHub, Netlify, or self-hosting on your own server. Styling and choice of components is kept to a minimum so that you may craft or "cooper" your own site.

:sparkles: See what's new in the CHANGELOG.

Notable Features

Bundled as a "theme gem" for modern Jekyll compatibility.
Compatible with GitHub Pages.
Compatible with Netlify
Support for Jekyll's built-in Sass/SCSS preprocessor.
Built for simple layout.
Optimized for search engines with support for Twitter Cards and Open Graph data.
Optional header images, custom sidebars, table of contents, galleries, related posts, breadcrumb links, navigation lists, and more.
No comment system by design.
Google Analytics support.

Demo Pages

Name	Description
[Post with Header Image][header-image-post]	A post with a large header image.
[HTML Tags and Formatting Post][html-tags-post]	A variety of common markup showing how the theme styles them.
[Syntax Highlighting Post][syntax-post]	Post displaying highlighted code.
[Post with a Gallery][gallery-post]	A post showing several images wrapped in `<figure>` elements.
[Sample Collection Page][sample-collection]	Single page from a collection.
[Categories Archive][categories-archive]	Posts grouped by category.
[Tags Archive][tags-archive]	Posts grouped by tag.

Additional sample posts are available under posts archive on the demo site. Source files for these (and the entire demo site) can be found in /docs.

Installation

There are three ways to install the theme:

Ruby gem (for self-hosted sites)
Ruby gem + jekyll-remote-theme plugin (GitHub Pages hosted sites)
Forking/directly copying all of the theme files into your project

Ruby Gem Method

Install the theme as a Ruby Gem by adding it to your Gemfile like so:
```
gem "cooper-jekyll-theme"
```
Fetch and update bundled gems by running the following Bundler command:
```
bundle
```
Set the theme in your project's Jekyll _config.yml file:
```
theme: cooper-jekyll-theme
```

To update the theme run bundle update.

GitHub Pages Method

Create/replace the contents of your Gemfile with the following:

source "https://rubygems.org"

gem "github-pages", group: :jekyll_plugins

Fetch and update bundled gems by running the following Bundler command:
```
bundle
```
Add remote_theme: "chrisjm/cooper" to your _config.yml file. Remove any other theme: or remote_theme: entry.

Usage

For detailed instructions on how to configure, customize, add/migrate content, and more read the theme's documentation.

Contributing

Having trouble working with the theme? Found a typo in the documentation? Interested in adding a feature or fixing a bug? Then by all means submit an issue or pull request. If this is your first pull request, it may be helpful to read up on the GitHub Flow first.

Cooper has been designed as a base for you to customize and fit your site's unique needs. Please keep this in mind when requesting features and/or submitting pull requests.

Pull Requests

When submitting a pull request:

Clone the repo.
Create a branch off of master and give it a meaningful name (e.g. feature/awesome-feature or bug/fix-broken-thing).
Open a pull request on GitHub and describe the feature or fix.

Theme documentation and demo pages can be found in the /docs if submitting improvements, typo corrections, etc.

Development

To set up your environment to develop this theme, run bundle install.

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

Credits

Creator

Chris J Mears

Icons + Demo Images:

The Noun Project -- Garrett Knoll, Arthur Shlain, and tracy tam
Font Awesome
Unsplash

Other:

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Cooper incorporates icons from The Noun Project creators Garrett Knoll, Arthur Shlain, and tracy tam. Icons are distributed under Creative Commons Attribution 3.0 United States (CC BY 3.0 US).

Cooper incorporates photographs from Unsplash.

Cooper incorporates Breakpoint. Breakpoint is distributed under the terms of the MIT/GPL Licenses.