Twitter Bootstrap + Bootflat + Fontawesome = jekyll-bootflat = a Jekyll gem based theme
CSS HTML Other
Latest commit ed8e6fa Jan 14, 2017 @haslinger haslinger version bump

README.md

jekyll-bootflat

jekyll-bootflat is a gem based theme for Jekyll, and has been extracted out of jekyll octopod and will be used there.

It is basically a Twitter Bootstrap theme, but extended by Bootflat and Font Awesome.

I am a Bootflat fanboy, and I agree to their tagline "Bootflat is built on the foundations of Bootstrap, visioned in a stunning flat design."

Preview

What's better than a screenshot?

preview

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-bootflat"

And add this line to your Jekyll site's _config.yml:

theme: jekyll-bootflat

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-bootflat

Usage

We stick to their styles, so you won't find any additional documentation here.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jekyll-octopod/jekyll-bootflat. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant 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, and _sass tracked with Git will be released.

License

The theme is available as open source under the terms of the MIT License.