kiko-minus-gh 0.0.1 → 0.0.2
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 +5 -5
- data/README.md +7 -36
- metadata +3 -3
- data/_layouts/archive.html +0 -33
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA1:
|
|
3
|
+
metadata.gz: 777106f35225221c99236117f4c347dd8db21b87
|
|
4
|
+
data.tar.gz: 6b6355f2fc54cd5b287164f8cb43549503f6b10a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6484939ece8ec65ee8c4e39f8ba043a343bff0cf9ccd057e1ba93d86a8f341287dc75d397d55beddf5e77212b85da355b9909cf528ab315c494253cd9f978366
|
|
7
|
+
data.tar.gz: 6d26789d31bfffe2fb85c032b703e51af562e70aef1d450e1f03c3e56a5ccabace8f4acb582ef936c0265e3e66d2a5fa39e29e4bf932add5784183c79ce11357
|
data/README.md
CHANGED
|
@@ -1,23 +1,20 @@
|
|
|
1
1
|
# kiko-minus
|
|
2
2
|
|
|
3
|
-
[](https://badge.fury.io/rb/kiko-minus)
|
|
3
|
+
[](https://badge.fury.io/rb/kiko-minus-gh)
|
|
4
4
|
|
|
5
5
|
kiko-minus is a minimalistic Jekyll theme based on [kiko-plus](https://github.com/aweekj/Kiko-plus).
|
|
6
6
|
|
|
7
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.
|
|
8
8
|
|
|
9
|
-
[Demo](https://
|
|
9
|
+
[Demo](https://ask616.github.io/kiko-minus-gh)
|
|
10
10
|
|
|
11
11
|
|
|
12
12
|
|
|
13
13
|
## Features
|
|
14
14
|
- Ready for use with GitLab or GitHub pages
|
|
15
15
|
- Syntax highlighting
|
|
16
|
-
- Automatic image compression
|
|
17
|
-
- Zopfli compression (gzip)
|
|
18
16
|
- Fully responsive
|
|
19
17
|
- Automatic sitemap generation
|
|
20
|
-
- Filtered pagination based on tags & collections
|
|
21
18
|
- Private comments with [ISSO](https://posativ.org/isso/)
|
|
22
19
|
- Analytics with [Fathom](https://usefathom.com/)
|
|
23
20
|
- Automatic Atom feed
|
|
@@ -31,10 +28,10 @@ You can use kiko-minus on your site after scaffolding with `jekyll new`:
|
|
|
31
28
|
Add this line to your Jekyll site's `Gemfile`:
|
|
32
29
|
|
|
33
30
|
```ruby
|
|
34
|
-
gem "kiko-minus"
|
|
31
|
+
gem "kiko-minus-gh"
|
|
35
32
|
```
|
|
36
33
|
|
|
37
|
-
Copy this [configuration](https://github.com/ask616/kiko-minus/blob/master/_config.yml) to your site's `_config.yml`.
|
|
34
|
+
Copy this [configuration](https://github.com/ask616/kiko-minus-gh/blob/master/_config.yml) to your site's `_config.yml`.
|
|
38
35
|
|
|
39
36
|
And then execute:
|
|
40
37
|
|
|
@@ -42,9 +39,8 @@ And then execute:
|
|
|
42
39
|
|
|
43
40
|
Or install it yourself as:
|
|
44
41
|
|
|
45
|
-
$ gem install kiko-minus
|
|
42
|
+
$ gem install kiko-minus-gh
|
|
46
43
|
|
|
47
|
-
Finally, make sure to follow the directions [below](https://github.com/ask616/kiko-minus#pagination) to enable pagination on your home page.
|
|
48
44
|
|
|
49
45
|
## Contents
|
|
50
46
|
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.
|
|
@@ -54,8 +50,6 @@ kiko-minus has an assortment of components to minimize additional needed configu
|
|
|
54
50
|
* `home.html` is used for the index page, and includes a navigation bar and the paginated list of all posts.
|
|
55
51
|
* `page.html` is used for individual pages i.e. an About or Contact page.
|
|
56
52
|
* `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.
|
|
58
|
-
* `archive.html` shows a condensed view of many posts and their publishing dates.
|
|
59
53
|
|
|
60
54
|
### `_includes/`
|
|
61
55
|
* `footer.html` is put at the bottom of every page to show copyright information.
|
|
@@ -75,26 +69,14 @@ Inside `kiko-minus/`:
|
|
|
75
69
|
|
|
76
70
|
### `assets/`
|
|
77
71
|
* `css/` contains a single `style.scss` file that imports the rest of the base kiko-minus styles. This is also where custom stylesheets can go, as explained [below](https://github.com/ask616/kiko-minus#custom-stylesheets).
|
|
78
|
-
* `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.
|
|
72
|
+
* `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.
|
|
79
73
|
|
|
80
74
|
### 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
|
-
* `categories/` and `tags/` can be used to define category or tag filtered pages.
|
|
83
75
|
* `pages/` can be used for individual pages.
|
|
84
|
-
* `index.
|
|
76
|
+
* `index.html` is the home page for your site.
|
|
85
77
|
|
|
86
78
|
## Usage
|
|
87
79
|
|
|
88
|
-
### Pagination
|
|
89
|
-
On your `index.md` and any other post list pages that you want paginated (such as category and tag pages), you'll need to add some configuration to each page's front matter. At the very least, you will need the following:
|
|
90
|
-
|
|
91
|
-
```
|
|
92
|
-
pagination:
|
|
93
|
-
enabled: true
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
For more configuration options, you can read the plugin's [docs](https://github.com/sverrirs/jekyll-paginate-v2/blob/master/README-GENERATOR.md#site-configuration).
|
|
97
|
-
|
|
98
80
|
### Custom Stylesheets
|
|
99
81
|
To add your own stylesheet, uncomment the `css` entry in `_config.yml`, and add the location of the stylesheet as its `src`.
|
|
100
82
|
|
|
@@ -118,17 +100,6 @@ fathom('trackPageview');
|
|
|
118
100
|
|
|
119
101
|
In this case, the script is hosted at https://mysite.dev/analytics/tracker.js, and its site ID is ABCDE.
|
|
120
102
|
|
|
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
|
-
### 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.
|
|
132
103
|
|
|
133
104
|
### Favicons
|
|
134
105
|
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.
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: kiko-minus-gh
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Areeb Khan
|
|
@@ -107,7 +107,6 @@ files:
|
|
|
107
107
|
- _includes/footer.html
|
|
108
108
|
- _includes/isso.html
|
|
109
109
|
- _includes/post-list.html
|
|
110
|
-
- _layouts/archive.html
|
|
111
110
|
- _layouts/default.html
|
|
112
111
|
- _layouts/home.html
|
|
113
112
|
- _layouts/page.html
|
|
@@ -139,7 +138,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
139
138
|
- !ruby/object:Gem::Version
|
|
140
139
|
version: '0'
|
|
141
140
|
requirements: []
|
|
142
|
-
|
|
141
|
+
rubyforge_project:
|
|
142
|
+
rubygems_version: 2.5.2.3
|
|
143
143
|
signing_key:
|
|
144
144
|
specification_version: 4
|
|
145
145
|
summary: A minimalistic, lightweight Jekyll theme based on Kiko Plus. This is a stripped
|
data/_layouts/archive.html
DELETED
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
layout: page
|
|
3
|
-
title: Archive
|
|
4
|
-
pagination:
|
|
5
|
-
enabled: true
|
|
6
|
-
per_page: 1000
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
<div class="archive">
|
|
10
|
-
<div class="archive-list">
|
|
11
|
-
{% if site.posts.size == 0 %}
|
|
12
|
-
<h2>No posts found</h2>
|
|
13
|
-
{% else %}
|
|
14
|
-
|
|
15
|
-
{% for post in paginator.posts %}
|
|
16
|
-
<div class="archive-list-item">
|
|
17
|
-
{% if post.link %}
|
|
18
|
-
<a href="{{ post.link }}">
|
|
19
|
-
{% else %}
|
|
20
|
-
<a href="{{ post.url | prepend: site.baseurl }}">
|
|
21
|
-
{% endif %}
|
|
22
|
-
<span class="archive-list-item-title">
|
|
23
|
-
{{ post.title }}
|
|
24
|
-
</span>
|
|
25
|
-
<span class="archive-list-item-date">
|
|
26
|
-
<time>| {{ post.date | date_to_string }}</time>
|
|
27
|
-
</span>
|
|
28
|
-
</a>
|
|
29
|
-
</div>
|
|
30
|
-
{% endfor %}
|
|
31
|
-
{% endif %}
|
|
32
|
-
</div>
|
|
33
|
-
</div>
|