minimal-categorized is a flexible Jekyll theme, designed for sites with content easily aggregated into two categories. It's main focus is on separating two main categories, while maintaining minimal style and full customization. Demo is available here.
There are three ways to install:
As a ruby gem theme:
Add this line to your Jekyll site's Gemfile
:
gem "minimal-categorized"
And add this line to your Jekyll site's _config.yml
:
theme: minimal-categorized
And then execute:
$ bundle
Or install it yourself as:
$ gem install minimal-categorized
As a remote theme (GitHub Pages compatible)
In your Jekyll site's _config.yml remove other themes and add this entry:
remote_theme: ItsMeaga1n/minimal-categorized
Forking/directly copying all of the theme files into your project.
This theme is based on separating content into categories, which is later shown on separated sites designated to the specific content type.
As for now, theme allows to use two main categories that will be displayed on home screen and more categories displayed only in menu to further separate content. Those are defined in _data/menu.yml
.
Structure of _data/menu.yml
:
Structure of _data/metaData.yml
:
Bug reports and pull requests are welcome on GitHub. 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.
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 minimal-categorized.gemspec
accordingly.
The theme is available as open source under the terms of the MIT License.