kiko-minus 1.0.4 → 1.0.5

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: dfc1022a99ca749009e37ac2df56379537b33308
4
- data.tar.gz: 3705fd9fe63bd65bad95080a714abaecdf298507
2
+ SHA256:
3
+ metadata.gz: 01a08bbd810bf1087098b1dc49035dbfb5e917b8477f6e7da6c5176b05a8d623
4
+ data.tar.gz: a484663a5065fbf30d96a7cc2e2c4282167407ca7cf11ef42e64bf0d700bf23a
5
5
  SHA512:
6
- metadata.gz: e89806b7b1cd81f6ecaa581abc4084496c95d9b75cf7ea44d4200aa4dc8228f649e9da58951c029c7bbdee2509fc037df5db7ec04017ac997a6298bf11733e5b
7
- data.tar.gz: 9085f9eddb03725c6016121dc96225da178cc402ae1b6f9219537d8931b7ceb2e210e6d05df7232f0237c35b933c6131b56fd71faf1b06c81f7adaa27c6e6b20
6
+ metadata.gz: 47ca985d7baaa851b317930bb397a2018b6eda8f3dcdfeabda8b89825365678fd3d7b0dd268d13226e58311e9286e7895bc3bcdae039ee176e2a907c3955fd1b
7
+ data.tar.gz: af427a1a8f81011088ac664dc83918c3f1fa96a8fe203c7ac6bc5e73a64f3baefc51efefdd2a49f0fe8f6d09fad61c56d660a4db527048b6a0b05159f7e08750
data/README.md CHANGED
@@ -4,17 +4,16 @@
4
4
 
5
5
  kiko-minus is a minimalistic Jekyll theme based on [kiko-plus](https://github.com/aweekj/Kiko-plus).
6
6
 
7
- While the design and styles are largely inherited from the original theme, kiko-minus strips away heavy dependencies like Google Analytics and Disqus in favor of lightweight alternatives. It comes with many additional features with an emphasis on privacy and speed, including automatically compressed images, gzip compression, and SEO optimization.
7
+ While the design and styles are largely inherited from the original theme, kiko-minus strips away heavy dependencies like Google Analytics and Disqus in favor of lightweight alternatives.
8
8
 
9
9
  [Demo](https://areebk.gitlab.io/kiko-minus/)
10
10
 
11
+ *Warning*: This theme is not compatible with Github Pages, which only supports [these](https://pages.github.com/versions/) plugins.
12
+
11
13
  ![Screenshot](screenshot.png)
12
14
 
13
15
  ## Features
14
- - Ready for use with GitLab or GitHub pages
15
16
  - Syntax highlighting
16
- - Automatic image compression
17
- - Zopfli compression (gzip)
18
17
  - Fully responsive
19
18
  - Automatic sitemap generation
20
19
  - Filtered pagination based on tags & collections
@@ -22,10 +21,8 @@ While the design and styles are largely inherited from the original theme, kiko-
22
21
  - Analytics with [Fathom](https://usefathom.com/)
23
22
  - Automatic Atom feed
24
23
  - No JavaScript, third party requests, or cookies (unless using Fathom or ISSO)
25
- - Structured data support (TODO)
26
24
 
27
25
  ## Installation
28
-
29
26
  You can use kiko-minus on your site after scaffolding with `jekyll new`:
30
27
 
31
28
  Add this line to your Jekyll site's `Gemfile`:
@@ -46,18 +43,25 @@ Or install it yourself as:
46
43
 
47
44
  Finally, make sure to follow the directions [below](https://github.com/ask616/kiko-minus#pagination) to enable pagination on your home page.
48
45
 
46
+ You can refer to [this](https://gitlab.com/areebk/blog) example for guidance.
47
+
48
+ ### Updating
49
+ To update your blog to the latest version of the theme, simply run `bundle update`, or specify the version of kiko-minus you want in your Gemfile, and run `bundle update`.
50
+
49
51
  ## Contents
50
52
  kiko-minus has an assortment of components to minimize additional needed configuration, so that all you need to do is add your posts to `_posts/` and be ready to go.
51
53
 
52
54
  ### `_layouts/`
53
55
  * `default.html` defines the basic structure of every page, including SEO tags, stylesheet imports, and favicons.
54
- * `home.html` is used for the index page, and includes a navigation bar and the paginated list of all posts.
56
+ * `home.html` is used for the index page, and includes a navigation bar and some intro text.
57
+ * `posts.html` is used to show a list of all your posts.
55
58
  * `page.html` is used for individual pages i.e. an About or Contact page.
56
59
  * `post.html` is for your blog posts, and can include a comment section if ISSO is enabled.
57
- * `filtered-home.html` is meant to be used for filtered post lists i.e. pages listing all posts belonging to a category or tag. The sample [wikipedia](https://github.com/ask616/kiko-minus/blob/master/categories/wikipedia.md) page is an example use case to show all posts that are Wikipedia articles.
60
+ * `filtered-posts.html` is meant to be used for filtered post lists i.e. pages listing all posts belonging to a category or tag. The sample [wikipedia](https://github.com/ask616/kiko-minus/blob/master/categories/wikipedia.md) page is an example use case to show all posts that are Wikipedia articles.
58
61
  * `archive.html` shows a condensed view of many posts and their publishing dates.
59
62
 
60
63
  ### `_includes/`
64
+ * `header.html` is put at the top of the home page and posts page.
61
65
  * `footer.html` is put at the bottom of every page to show copyright information.
62
66
  * `post-list.html` renders out a list of posts as defined by pagination.
63
67
  * `isso.html` contains the ISSO script tag and is included if comments are enabled. The tag also includes many of the configurable options as defined [here](https://posativ.org/isso/docs/configuration/client/).
@@ -78,7 +82,6 @@ Inside `kiko-minus/`:
78
82
  * `img/` is where your images will go for use throughout the site. You can add subfolders here as is done in this sample to better organize. Be warned that the photos here will be optimized *in place*, and that the originals will be copied over to `assets/img_archive` (or as otherwise defined in your config), which isn't included in your website's build.
79
83
 
80
84
  ### Misc
81
- * `.image-optim-cache` is used by the image optimization [plugin](https://github.com/ask616/jekyll-image-optim) to keep track of what files have already been optimized. *Do not delete this!*
82
85
  * `categories/` and `tags/` can be used to define category or tag filtered pages.
83
86
  * `pages/` can be used for individual pages.
84
87
  * `index.md` is the home page for your site.
@@ -118,17 +121,8 @@ fathom('trackPageview');
118
121
 
119
122
  In this case, the script is hosted at https://mysite.dev/analytics/tracker.js, and its site ID is ABCDE.
120
123
 
121
- ### Gzip Compression
122
- If configured, kiko-minus will automatically create gzipped versions of your text files that will be served by default if GitHub or GitLab pages, or if otherwise configured on your host. As explained in the plugin's [usage](https://github.com/philnash/jekyll-zopfli#usage), the site must be built in production mode to create the gzipped bundles by setting the `JEKYLL_ENV` environment variable as such:
123
-
124
- ```
125
- JEKYLL_ENV=production bundle exec jekyll build
126
- ```
127
-
128
- This is done because creating the bundles can be slow, and so should only be done in production mode.
129
-
130
124
  ### Category and Tag Pages
131
- The plugin [jekyll-paginate-v2](https://github.com/sverrirs/jekyll-paginate-v2/) lets us paginate on categories and tags (and much more!). The directions for enabling pagination can be found in their [docs](https://github.com/sverrirs/jekyll-paginate-v2/blob/master/README-GENERATOR.md#paginate-categories-tags-locales), and an example is provided here with [wikipedia articles](https://github.com/ask616/kiko-minus/blob/master/categories/wikipedia.md) page. It is _highly_ recommended that you use the `filtered-home` layout for these pages.
125
+ The plugin [jekyll-paginate-v2](https://github.com/sverrirs/jekyll-paginate-v2/) lets us paginate on categories and tags (and much more!). The directions for enabling pagination can be found in their [docs](https://github.com/sverrirs/jekyll-paginate-v2/blob/master/README-GENERATOR.md#paginate-categories-tags-locales), and an example is provided here with [wikipedia articles](https://github.com/ask616/kiko-minus/blob/master/categories/wikipedia.md) page. It is _highly_ recommended that you use the `filtered-posts` layout for these pages.
132
126
 
133
127
  ### Favicons
134
128
  kiko-minus supports including a 16x16 and 32x32 px favicon for your site. Place them in the `assets/img/logos/` directory with the names `favicon-16x16.png` and `favicon-32x32.png`, respectively, and they'll automatically be loaded.
@@ -0,0 +1,5 @@
1
+ <nav class="header-nav">
2
+ {% for nav in site.nav %}
3
+ <a href="{{ nav.url | prepend: site.baseurl }}">{{ nav.name }}</a>
4
+ {% endfor %}
5
+ </nav>
@@ -7,19 +7,9 @@ layout: default
7
7
  <a href="{{ site.url }}{{ site.baseurl }}">{{ site.title }}</a>
8
8
  </div>
9
9
 
10
- <nav class="header-nav">
11
- {% for nav in site.nav %}
12
- <a href="{{ nav.url | prepend: site.baseurl }}">{{ nav.name }}</a>
13
- {% endfor %}
14
- </nav>
10
+ {%- include header.html -%}
15
11
  </header>
16
12
 
17
- <div class="post-list">
18
- {% if site.posts.size == 0 %}
19
- <h2>No posts found</h2>
20
- {% else %}
21
-
22
- {%- include post-list.html -%}
23
-
24
- {% endif %}
13
+ <div class="page-content">
14
+ {{ content }}
25
15
  </div>
@@ -0,0 +1,19 @@
1
+ ---
2
+ layout: default
3
+ ---
4
+
5
+ <header>
6
+ <div class="header-title">
7
+ <a href="{{ site.url }}{{ site.baseurl }}">{{ site.title }}</a>
8
+ </div>
9
+
10
+ {%- include header.html -%}
11
+ </header>
12
+
13
+ <div class="post-list">
14
+ {% if site.posts.size == 0 %}
15
+ <h2>No posts quite yet</h2>
16
+ {% else %}
17
+ {%- include post-list.html -%}
18
+ {% endif %}
19
+ </div>
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: kiko-minus
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.4
4
+ version: 1.0.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Areeb Khan
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-06-29 00:00:00.000000000 Z
11
+ date: 2020-04-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -16,98 +16,70 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: '3.8'
19
+ version: '4.0'
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: '3.8'
27
- - !ruby/object:Gem::Dependency
28
- name: jekyll-seo-tag
29
- requirement: !ruby/object:Gem::Requirement
30
- requirements:
31
- - - "~>"
32
- - !ruby/object:Gem::Version
33
- version: '2.6'
34
- type: :runtime
35
- prerelease: false
36
- version_requirements: !ruby/object:Gem::Requirement
37
- requirements:
38
- - - "~>"
39
- - !ruby/object:Gem::Version
40
- version: '2.6'
26
+ version: '4.0'
41
27
  - !ruby/object:Gem::Dependency
42
28
  name: jekyll-feed
43
29
  requirement: !ruby/object:Gem::Requirement
44
30
  requirements:
45
31
  - - "~>"
46
32
  - !ruby/object:Gem::Version
47
- version: '0.12'
33
+ version: '0.13'
48
34
  type: :runtime
49
35
  prerelease: false
50
36
  version_requirements: !ruby/object:Gem::Requirement
51
37
  requirements:
52
38
  - - "~>"
53
39
  - !ruby/object:Gem::Version
54
- version: '0.12'
40
+ version: '0.13'
55
41
  - !ruby/object:Gem::Dependency
56
42
  name: jekyll-paginate-v2
57
43
  requirement: !ruby/object:Gem::Requirement
58
44
  requirements:
59
45
  - - "~>"
60
46
  - !ruby/object:Gem::Version
61
- version: '2.0'
62
- type: :runtime
63
- prerelease: false
64
- version_requirements: !ruby/object:Gem::Requirement
65
- requirements:
66
- - - "~>"
67
- - !ruby/object:Gem::Version
68
- version: '2.0'
69
- - !ruby/object:Gem::Dependency
70
- name: jekyll-sitemap
71
- requirement: !ruby/object:Gem::Requirement
72
- requirements:
73
- - - "~>"
74
- - !ruby/object:Gem::Version
75
- version: '1.3'
47
+ version: '3.0'
76
48
  type: :runtime
77
49
  prerelease: false
78
50
  version_requirements: !ruby/object:Gem::Requirement
79
51
  requirements:
80
52
  - - "~>"
81
53
  - !ruby/object:Gem::Version
82
- version: '1.3'
54
+ version: '3.0'
83
55
  - !ruby/object:Gem::Dependency
84
- name: jekyll-zopfli
56
+ name: jekyll-seo-tag
85
57
  requirement: !ruby/object:Gem::Requirement
86
58
  requirements:
87
59
  - - "~>"
88
60
  - !ruby/object:Gem::Version
89
- version: '2.1'
61
+ version: '2.6'
90
62
  type: :runtime
91
63
  prerelease: false
92
64
  version_requirements: !ruby/object:Gem::Requirement
93
65
  requirements:
94
66
  - - "~>"
95
67
  - !ruby/object:Gem::Version
96
- version: '2.1'
68
+ version: '2.6'
97
69
  - !ruby/object:Gem::Dependency
98
- name: jekyll-image-optim
70
+ name: jekyll-sitemap
99
71
  requirement: !ruby/object:Gem::Requirement
100
72
  requirements:
101
73
  - - "~>"
102
74
  - !ruby/object:Gem::Version
103
- version: '1.0'
75
+ version: '1.4'
104
76
  type: :runtime
105
77
  prerelease: false
106
78
  version_requirements: !ruby/object:Gem::Requirement
107
79
  requirements:
108
80
  - - "~>"
109
81
  - !ruby/object:Gem::Version
110
- version: '1.0'
82
+ version: '1.4'
111
83
  - !ruby/object:Gem::Dependency
112
84
  name: bundler
113
85
  requirement: !ruby/object:Gem::Requirement
@@ -133,14 +105,16 @@ files:
133
105
  - README.md
134
106
  - _includes/fathom.html
135
107
  - _includes/footer.html
108
+ - _includes/header.html
136
109
  - _includes/isso.html
137
110
  - _includes/post-list.html
138
111
  - _layouts/archive.html
139
112
  - _layouts/default.html
140
- - _layouts/filtered-home.html
113
+ - _layouts/filtered-posts.html
141
114
  - _layouts/home.html
142
115
  - _layouts/page.html
143
116
  - _layouts/post.html
117
+ - _layouts/posts.html
144
118
  - _sass/kiko-minus.scss
145
119
  - _sass/kiko-minus/_colors.scss
146
120
  - _sass/kiko-minus/_layout.scss
@@ -168,8 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
168
142
  - !ruby/object:Gem::Version
169
143
  version: '0'
170
144
  requirements: []
171
- rubyforge_project:
172
- rubygems_version: 2.5.2.3
145
+ rubygems_version: 3.0.3
173
146
  signing_key:
174
147
  specification_version: 4
175
148
  summary: A minimalistic, lightweight Jekyll theme based on Kiko Plus