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.
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 Page¶ ↑
The front page contains a sidebar listing categories, tags, and series, as well as a list of the most recent posts. The desktop version is shown above; here is the mobile version of the front page.
Post¶ ↑
The post page renders the layout for a post:
All Posts¶ ↑
All posts can be shown in a nice table or list:
Page¶ ↑
Static content can be rendered in its own page. Pages can optionally be placed on the top navbar of the site.
Group Pages¶ ↑
Posts are grouped by category, tag, or series. All of the related posts are grouped into their own page.
A Post in a Series¶ ↑
At the bottom of every post belonging to a series, helpful navigation links appear between the posts in the series.
Contributing¶ ↑
Bug reports and pull requests are welcome on GitHub at 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.