Personal Jekyll Theme for crnbrdck
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_includes
_layouts
_sass
assets
.gitignore
Gemfile
LICENSE.txt
README.md
_config.yml
storm.gemspec

README.md

title layout permalink
Storm
home
/

storm

Storm is a Jekyll theme that's powered by Bulma.

Designed by crnbrdrck for his personal GitHub pages sites, but if you want to use it too that's fine!

Installation

Add this line to your Jekyll site's Gemfile:

gem "storm"

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

theme: storm

And then execute:

$ bundle

Or install it yourself as:

$ gem install storm

{% include admonition.html level="info" title="Note" message="Not yet available as a gem, but it will be soon!" %}

Usage

If you are interested in using this theme, here's a couple of things you'll need to keep in mind

Config

A couple of things are needed for the config file if you're going to use this theme;

  • title: The title of the project; displayed on the navbar
  • short_title: A short (12 chars or less) version of the site title, for the manifest
  • email: The author's email; will be placed in the author meta tag
  • description: A short description of the project; will be placed in the description meta tag
  • navigation: See here

As well, there's an optional setting that is recommended in order to improve performance;

sass:
  style: compressed

This instructs Jekyll to compress the sass files, giving better performance.

Navigation

Storm supports control over the navbar from your _config.yml file using the navigation key.

Two layers are supported, with the second layer being rendered as a dropdown.

To set it up, use the following as an example;

navigation:
  - name: Home
    url: /
  - name: About
    url: /about/
  - name: Dropdown
    dropdown:
      - name: Home
        url: /
      - name: About
        url: /about/

Navigation is an array of maps with 3 keys that are accepted;

  • name: The name to display in the navbar
  • url: The url for the link to go to
  • dropdown: An array of maps that follow the same structure to be rendered in a dropdown menu
    • Please note that dropdown keys are not allowed to be used inside a dropdown array and will be ignored

One of url or dropdown must be given or else the navbar item will not be rendered

Layouts

Currently, only the home layout exists that is currently usable. It draws the basic page and loads in whatever content is in the md file presented to it.

Includes

  • navbar.html: Handles the rendering of the navbar on the top of the page
  • admonition.html: Draws block messages in primary, info, success, warning or danger colours
    • See example usage above

Contributing

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

License

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