search

chrisrhymes / bulma-clean-theme

A clean and modern Jekyll theme based on Bulma
http://www.csrhymes.com/bulma-clean-theme/
MIT License
388 stars 492 forks source link
bulma bulma-clean-theme jekyll jekyll-theme jekyll-themes theme

readme

bulma-clean-theme

Gem Version Gem

This is a clean and simple Jekyll Theme built with the Bulma framework, providing a modern-looking site to start with.

The theme uses Alpine.js for its interactive components, such as mobile navbar and notifications.

Contents

Installation

Add this line to your Jekyll site's Gemfile:

gem "bulma-clean-theme"

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

theme: bulma-clean-theme

And then execute:

$ bundle

Or install it yourself as:

$ gem install bulma-clean-theme

GitHub pages

v1.0

To deploy to GitHub pages using v1.x you will need to use GitHub Actions. Please see the upgrade guide for more information.

v0.x

If you are deploying to GitHub pages using their default build process, then you can install v0.x of the GitHub Pages gem and use remote_theme instead of theme in your _config.yml.

Note that the GitHub Pages gem requires Jekyll version 3.9 and version 0.x of Bulma Clean Theme

# With GitHub Pages Gem
remote_theme: chrisrhymes/bulma-clean-theme@v0.14.0

Documentation

Check out the demo site for the Documentation

Upgrading to v1

There are several breaking changes for v1. Please read the upgrade guide for more information.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/chrisrhymes/bulma-clean-theme. 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 set up 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.

License

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