jekyll-theme-nn

jekyll-theme-nn

The Jekyll Theme for my site

jekyll-theme-nn

This repository contains a Jekyll Theme setup as a Gem. This theme is used for my own personal site. You are welcome to use it as well, if you'd like. A live site using this theme can be found here: https://blog.nicholasnooney.com

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-nn"

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

theme: jekyll-theme-nn

And then execute:

    bundle

Or install it yourself as:

    gem install jekyll-theme-nn

Usage

This theme supports the following layouts, both in Desktop and Mobile:

  • Front
    • Displays a Hero section, a side menu (Desktop Only), and a list of recent posts.
  • Page
    • Displays a static page's contents. A page can be added to the top navbar.
  • Post
    • Displays a post's contents.
  • Group
    • Displays a group of related posts.

Additionally, this theme supports several components for organizing posts

  • Series
    • Using the YAML front matter series, posts can be grouped into any series.
    • in the file _data/series.yml, descriptions for each series can be provided.
  • All Posts
    • All posts can be displayed in a table (Desktop) or list of cards (Mobile) for easy site navigation.

Desktop





Mobile






Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/nnooney/jekyll-theme-nn. Since this is a personal project, I will review and make updates at my own pace.

License

This theme is available as open source under the terms of the MIT License. A copy of this license is included in this repository at LICENSE.txt.

This project also makes use of third party licenses that are distributed under their own terms. These libraries are listed below:

  • This project makes use of Bulma. Bulma is included in this project at assets/vendor/bulma. See Bulma's LICENSE.
  • This project uses Feather Icons. Feather is included in this project at assets/vendor/feather. See Feather's LICENSE.
  • This project uses Nord colors. These colors are included at _sass/vendor/nord. See Nord's LICENSE.md.