jekyll-theme-nn 0.1.17 → 0.1.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 8ee2b79d11f0e52e08c964f341ac220e0473ec3c
4
- data.tar.gz: 808e8f55a2c2399d2925938a8839545ed7131a4a
3
+ metadata.gz: 18bbb961bae4cfae3de816b45207b36ae5f7d447
4
+ data.tar.gz: 2abedd5ad53c4e0feb8ca9e427a4a02b6d66f332
5
5
  SHA512:
6
- metadata.gz: a0419ec7a3adba7a3334f6643bb8a511398e4e32248e538417b4e9686c72420fa87b57980ff3461b1392f73e667d36e91c99a3ea902b6603ad71b3416ee8a3c0
7
- data.tar.gz: d7f203b8e98a877be572254d0b7d188c6046d7d2cb859897ab1c252fddf749d72a1fc8a933b09dc1ea0decbc8807972d94466bfb35b39646588fa1cc7d0395dd
6
+ metadata.gz: 031ed75ee26574fb8b1c5a979d34aaf400537a5f867c4aa6e35aebcce82defeebfcc1127dea17a064059e7b1a0ccafac23203df5779052f88ff89e26fff8f2bd
7
+ data.tar.gz: 0b235a45a51481107827a33fcd992c1e634a8705d04f68581e799a77b2eb030430994111cafc972cefd475ee6d186f9e06df5761aa61a3610be1f6f1a75582da
data/README.md CHANGED
@@ -1,12 +1,12 @@
1
- [![Gem](https://img.shields.io/gem/v/jekyll-theme-nn.svg)](https://rubygems.org/gems/jekyll-theme-nn)
2
-
3
1
  # jekyll-theme-nn
4
2
 
3
+ [![Gem](https://img.shields.io/gem/v/jekyll-theme-nn.svg)](https://rubygems.org/gems/jekyll-theme-nn)
4
+
5
5
  This repository contains a Jekyll Theme setup as a Gem. This theme
6
6
  is used for my own personal site. You are welcome to use it as
7
7
  well, if you'd like.
8
8
 
9
- ![The Front Page of the Theme](docs/front.png?raw=true "Front Page")
9
+ ![The Front Page](docs/front-desktop.png?raw=true "Front Page Desktop")
10
10
 
11
11
  ## Installation
12
12
 
@@ -24,15 +24,70 @@ theme: jekyll-theme-nn
24
24
 
25
25
  And then execute:
26
26
 
27
- $ bundle
27
+ ```sh
28
+ bundle
29
+ ```
28
30
 
29
31
  Or install it yourself as:
30
32
 
31
- $ gem install jekyll-theme-nn
33
+ ```sh
34
+ gem install jekyll-theme-nn
35
+ ```
32
36
 
33
37
  ## Usage
34
38
 
35
- This theme supports the following layouts:
39
+ This theme supports the following layouts, both in Desktop and Mobile:
40
+
41
+ ### Front Page
42
+
43
+ The front page contains a sidebar listing categories, tags, and series, as well
44
+ as a list of the most recent posts. The desktop version is shown above; here is
45
+ the mobile version of the front page.
46
+
47
+ ![The Front Page](docs/front-mobile.png?raw=true "Front Page Mobile")
48
+
49
+ ### Post
50
+
51
+ The post page renders the layout for a post:
52
+
53
+ ![A Post Page](docs/post-desktop.png?raw=true "Post Desktop")
54
+
55
+ ![A Post Page](docs/post-mobile.png?raw=true "Post Mobile")
56
+
57
+ ### All Posts
58
+
59
+ All posts can be shown in a nice table or list:
60
+
61
+ ![All Posts Page](docs/all-posts-desktop.png?raw=true "All Posts Desktop")
62
+
63
+ ![All Posts Page](docs/all-posts-mobile.png?raw=true "All Posts Mobile")
64
+
65
+ ### Page
66
+
67
+ Static content can be rendered in its own page. Pages can optionally be placed
68
+ on the top navbar of the site.
69
+
70
+ ![A Static Page](docs/page-desktop.png?raw=true "Page Desktop")
71
+
72
+ ![A Static Page](docs/page-mobile.png?raw=true "Page Mobile")
73
+
74
+ ### Group Pages
75
+
76
+ Posts are grouped by category, tag, or series. All of the related posts are
77
+ grouped into their own page.
78
+
79
+ ![A Post Group Page](docs/group-desktop.png?raw=true "Post Group Desktop")
80
+
81
+ ![A Post Group Page](docs/group-mobile.png?raw=true "Post Group Mobile")
82
+
83
+ ### A Post in a Series
84
+
85
+ At the bottom of every post belonging to a series, helpful navigation links
86
+ appear between the posts in the series.
87
+
88
+ ![A Post in a Series](docs/series-desktop.png?raw=true "Series Desktop")
89
+
90
+ ![A Post in a Series](docs/series-mobile.png?raw=true "Series Mobile")
36
91
 
37
92
  ## Contributing
38
93
 
@@ -0,0 +1,23 @@
1
+ {% comment %}
2
+ This template expects the following variables to be defined when including it:
3
+ - list: A list of items to create badges for.
4
+ - prepend_url: The url to prepend to each link.
5
+ - class: CSS classes to apply to the badge.
6
+ - limit: The maximum number of badges to create.
7
+ {% endcomment %}
8
+
9
+ {% assign list = include.list | default: nil %}
10
+ {% assign prepend_url = include.prepend_url | default: "" %}
11
+ {% assign class = include.class | default: "" %}
12
+ {% assign badge_limit = include.limit | default: 0 %}
13
+
14
+ {% for item in list %}
15
+ {% assign item_page = item | slugify | append: ".html" %}
16
+ <a href='{{ item_page | prepend: prepend_url | relative_url }}'
17
+ class='{{ class | append: " tag"}}'>
18
+ {{ item | escape }}
19
+ </a>
20
+ {% if badge_limit > 0 and forloop.index > badge_limit %}
21
+ {% break %}
22
+ {% endif %}
23
+ {% endfor %}
@@ -10,16 +10,14 @@
10
10
  {{ post.date | date: "%Y-%m-%d" }}
11
11
  </p>
12
12
  <p class="content">
13
- {% for category in post.categories %}
14
- <span class="tag is-info">
15
- {{ category | escape }}
16
- </span>
17
- {% endfor %}
18
- {% for tag in post.tags %}
19
- <span class="tag is-light">
20
- {{ tag | escape }}
21
- </span>
22
- {% endfor %}
13
+ {% include components/gen-badge.html
14
+ list=post.categories
15
+ prepend_url="/category/"
16
+ class="is-info" %}
17
+ {% include components/gen-badge.html
18
+ list=post.tags
19
+ prepend_url="/tags/"
20
+ class="is-light" %}
23
21
  </p>
24
22
  </div>
25
23
  </div>
@@ -32,21 +32,15 @@ This template expects the following variables to be defined when including it:
32
32
  <div class="level-right">
33
33
  <div class="level-item">
34
34
  <div class="tags">
35
- {% for category in post.categories %}
36
- {% assign cat_page = category | slugify | append: ".html" %}
37
- <a href="{{ cat_page | prepend: "/category/" | relative_url }}" class="tag is-info">
38
- {{ category | escape }}
39
- </a>
40
- {% endfor %}
41
- {% for tag in post.tags %}
42
- {% assign tag_page = tag | slugify | append: ".html" %}
43
- <a href="{{ tag_page | prepend: "/tags/" | relative_url }}" class="tag is-light">
44
- {{ tag | escape }}
45
- </a>
46
- {% if forloop.index > 3 %}
47
- {% break %}
48
- {% endif %}
49
- {% endfor %}
35
+ {% include components/gen-badge.html
36
+ list=post.categories
37
+ prepend_url="/category/"
38
+ class="is-info" %}
39
+ {% include components/gen-badge.html
40
+ list=post.tags
41
+ prepend_url="/tags/"
42
+ class="is-light"
43
+ limit=3 %}
50
44
  </div>
51
45
  </div>
52
46
  </div>
@@ -17,18 +17,16 @@
17
17
  </a>
18
18
  </td>
19
19
  <td>
20
- {% for category in post.categories %}
21
- <span class="tag is-info">
22
- {{ category | escape }}
23
- </span>
24
- {% endfor %}
20
+ {% include components/gen-badge.html
21
+ list=post.categories
22
+ prepend_url="/category/"
23
+ class="is-info" %}
25
24
  </td>
26
25
  <td>
27
- {% for tag in post.tags %}
28
- <span class="tag is-light">
29
- {{ tag | escape }}
30
- </span>
31
- {% endfor %}
26
+ {% include components/gen-badge.html
27
+ list=post.tags
28
+ prepend_url="/tags/"
29
+ class="is-light" %}
32
30
  </td>
33
31
  </tr>
34
32
  {% endfor %}
@@ -17,9 +17,10 @@ layout: default
17
17
  </div>
18
18
  <div class="level-right">
19
19
  <div class="tags">
20
- {% for tag in page.tags %}
21
- <span class="tag is-light">{{ tag }}</span>
22
- {% endfor %}
20
+ {% include components/gen-badge.html
21
+ list=page.tags
22
+ prepend_url="/tags/"
23
+ class="is-light" %}
23
24
  </div>
24
25
  </div>
25
26
  </div>
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-nn
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.17
4
+ version: 0.1.18
5
5
  platform: ruby
6
6
  authors:
7
7
  - Nicholas Nooney
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-11-04 00:00:00.000000000 Z
11
+ date: 2019-12-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -63,6 +63,7 @@ files:
63
63
  - README.md
64
64
  - _includes/components/feather-icon.html
65
65
  - _includes/components/featured-image.html
66
+ - _includes/components/gen-badge.html
66
67
  - _includes/components/hero.html
67
68
  - _includes/components/made-with.html
68
69
  - _includes/components/menu.html