materialized-jekyll

A materialized Jekyll theme built on top of minima and inspired by materialize-sass.

This theme is still under development.

I created the theme mainly because my own personal blog needs to freshen up.

Installation

Add this line to your Jekyll site's Gemfile:

gem "materialized-jekyll", :path => "/path/to/materialized-jekyll" #This theme is not supported by GitHub Pages, so you can only test locally; or copy this into your project.

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

theme: materialized-jekyll

And then execute:

$ bundle
$ cd _sass
$ npm install

Or install it yourself as:

$ gem install materialized-jekyll

Usage

layouts

includes

sass

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tinglu/materialized-jekyll/issues. 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.

To download required node modules, go to _sass dir, run $ npm 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.