kiko-minus 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d051d73e3324cb2f031803d1e97894598d0281ddff1188b8cade31185f657d3
-  data.tar.gz: 00226ca32288c8aa5afc6902c516f3e63796197748aed56f3ae02a35614cc105
+  metadata.gz: 460b1f62ed380f22627eb27e01997730907be89434cf5a0ab3983c60182cd9bf
+  data.tar.gz: 22a0592b73ae723ad99d26c0336f956dedc481182d2832058c3c63a8dec6688b
 SHA512:
-  metadata.gz: c128e7b70a0381b01374366f0474dd2e5a31f54e9160f6afccb97dc6da7be7adf3871c0862797d3e4a2fc6f68fe62e5dbc45470dac926607a3e6c4878bcac1ed
-  data.tar.gz: '0268ffe7c251ab837ba0a96ecce035e35357872c118aba6884d7bd4210835524c46a0e1e2f674d2eed794f4d19159b932b1674472a1052ef2bc91d28727787f2'
+  metadata.gz: 716ed9e73968ea3bbbc5f32b91a43a76611522299d9c20c6ac9bac87f16cbf15a53c703fbcbdcfb95c2dba6279fcf01c235ad2107127eaa4b1047aad29cc171b
+  data.tar.gz: d4e677d37833ca44e3d41d37d6b96e52f06f3bbe6fde3ed4933c3060896c5b21c67a9a812b782d9da98dcd575a6e969c82950e34891bdeac464542a2838fdde6

data/README.md

@@ -1,25 +1,26 @@
 # kiko-minus
 
-kiko-minus is a minimalistic Jekyll theme based on [kiko-plus](https://github.com/aweekj/Kiko-plus)
+[![Gem Version](https://badge.fury.io/rb/kiko-minus.svg)](https://badge.fury.io/rb/kiko-minus)
 
-While the design and styles are largely inherited from the original theme, kiko-minus comes with many additional features including an emphasis on privacy and speed, automatically compressed images, gzip compression, and SEO optimization.
+kiko-minus is a minimalistic Jekyll theme based on [kiko-plus](https://github.com/aweekj/Kiko-plus).
+
+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.
+
+![Screenshot](screenshot.png)
 
 ## Features
 - Ready for use with GitLab or GitHub pages
 - Syntax highlighting
 - Automatic image compression
-- Brotli, Zopfli, and Gzip compression
+- Zopfli compression (gzip)
 - Fully responsive
-- Automatic pagination
 - Automatic sitemap generation
-- Automatic page generation based on tags & collections (in progress)
-- Structured data (in progress)
-- SEO support (in progress)
-- LaTeX support (in progress)
-- Comments with ISSO (in progress)
-- Analytics with Fathom (in progress)
-- No third party requests or cookies (unless using Fathom or ISSO)
-- Automatic RSS feed (in progress)
+- Filtered pagination based on tags & collections
+- Private comments with [ISSO](https://posativ.org/isso/)
+- Analytics with [Fathom](https://usefathom.com/)
+- Automatic Atom feed
+- No JavaScript, third party requests, or cookies (unless using Fathom or ISSO)
+- Structured data support (TODO)
 
 ## Installation
 
@@ -29,11 +30,7 @@ Add this line to your Jekyll site's `Gemfile`:
 gem "kiko-minus"
 ```
 
-And add this line to your Jekyll site's `_config.yml`:
-
-```yaml
-theme: kiko-minus
-```
+Copy this [configuration](https://github.com/ask616/kiko-minus/blob/master/_config.yml) to your site's `_config.yml`.
 
 And then execute:
 
@@ -43,13 +40,80 @@ Or install it yourself as:
 
     $ gem install kiko-minus
 
+## Contents
+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.
+
+### `_layouts/`
+* `default.html` defines the basic structure of every page, including SEO tags, stylesheet imports, and favicons.
+* `home.html` is used for the index page, and includes a navigation bar and the paginated list of all posts.
+* `page.html` is used for individual pages i.e. an About or Contact page.
+* `post.html` is for your blog posts, and can include a comment section if ISSO is enabled.
+* `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.
+* `archive.html` shows a condensed view of many posts and their publishing dates.
+
+### `_includes/`
+* `footer.html` is put at the bottom of every page to show copyright information.
+* `post-list.html` renders out a list of posts as defined by pagination.
+* `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/).
+* `fathom.html` contains the tracker code and is included if analytics are enabled. The tag requires the address of your server and the site ID as provided by your Fathom instance.
+
+### `_sass/`
+`kiko-minus.scss` defines the main variables to be used in the rest of the styles, as well as a couple mixins to help make the site responsive. It also imports the rest of the partials.
+
+Inside `kiko-minus/`:
+* `_colors.scss` is copied from [Open color](https://yeun.github.io/open-color/) and defines a broad palette for easy use.
+* `_layout.scss` defines the overall structure of the site.
+* `_normalize.scss` is copied from [Normalize.css](https://necolas.github.io/normalize.css/) and is used to render the site consistently across all browsers.
+* `_syntax-highlighting.scss` defines how code is highlighted.
+* `_typography.scss` defines the look and feel of the elements on the site.
+
+### `assets/`
+* `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).
+* `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.
+
+### Misc
+* `.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!*
+* `categories/` and `tags/` can be used to define category or tag filtered pages.
+* `pages/` can be used for individual pages.
+* `index.md` is the home page for your site.
+
 ## Usage
 
-TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+### Custom Stylesheets
+To add your own stylesheet, uncomment the `css` entry in `_config.yml`, and add the location of the stylesheet as its `src`.
+
+### ISSO Integration
+To enable comments on your posts, set `isso.enabled` to `true` in your `_config.yml`, and add the location of the embed script as hosted by your ISSO server to `isso.script_src`. The other options can be deleted if you want the defaults as defined on ISSO's [website](https://posativ.org/isso/docs/configuration/client/).
+
+### Fathom Integration
+To enable analytics throughout the site, set `fathom.enabled` to `true` in your `_config.yml`, and add the location of the tracker script (i.e. https://yoursite.tld/analytics/tracker.js) to `fathom.script_src` and your site ID to `fathom.site_id`.
+
+If you don't know the location of the script and site ID, you can look at the tracking code provided on your Fathom dashboard:
+
+```
+...
+  m.parentNode.insertBefore(o,m)
+})(document, window, '//mysite.dev/analytics/tracker.js', 'fathom');
+fathom('set', 'siteId', 'ABCDE');
+fathom('trackPageview');
+...
+
+```
+
+In this case, the script is hosted at https://mysite.dev/analytics/tracker.js, and its site ID is ABCDE.
+
+### Category and Tag Pages
+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.
+
+### Favicons
+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.
+
+### SEO Setup
+This theme uses `jekyll-seo-tag` to help provide metadata to improve your SEO scores. You can supply information to the `_config.yml` as defined [here](https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/usage.md) (many of the options are already added to the config you copy over from this theme).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitLab at https://gitlab.com/areebk/kiko-minus/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ask616/kiko-minus/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Development
 
@@ -57,7 +121,7 @@ To set up your environment to develop this theme, run `bundle install`.
 
 Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
 
-When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
+When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets/css` tracked with Git will be bundled.
 To add a custom directory to your theme-gem, please edit the regexp in `kiko-minus.gemspec` accordingly.
 
 ## License

data/_includes/isso.html

@@ -1,6 +1,6 @@
 
 <script data-isso="{{ site.isso.prefix }}"
-        src="{{ site.isso.script_source }}"
+        src="{{ site.isso.script_src }}"
 
         {% if site.isso.css %}
         data-isso-css="{{ site.isso.css }}"

data/_includes/post-list.html

@@ -0,0 +1,39 @@
+{% for post in paginator.posts %}
+  <div class="post-list-item">
+    {% if post.link %}
+    <a href="{{ post.link }}">
+    {% else %}
+    <a href="{{ post.url | prepend: site.baseurl }}">
+    {% endif %}
+      <div class="post-list-item-date">
+        <time>{{ post.date | date_to_string }}</time>
+      </div>
+      <div class="post-list-item-title">
+        {{ post.title }}
+      </div>
+      {% if post.description %}
+      <div class="post-list-item-desc">
+        {{ post.description }}
+      </div>
+      {% endif %}
+    </a>
+  </div>
+{% endfor %}
+
+<div class="post-list-pagination">
+  <span class="post-list-pagination-previous">
+    {% if paginator.previous_page %}
+      <a href="{{ paginator.previous_page_path | prepend: site.baseurl }}" class="previous">
+        &#60; previous
+      </a>
+    {% endif %}
+  </span>
+
+  <span class="post-list-pagination-next">
+    {% if paginator.next_page %}
+      <a href="{{ paginator.next_page_path | prepend: site.baseurl }}" class="next">
+        next &#62;
+      </a>
+    {% endif %}
+  </span>
+</div>

data/_layouts/archive.html

@@ -0,0 +1,33 @@
+---
+layout: page
+title: Archive
+pagination:
+  enabled: true
+  per_page: 1000
+---
+
+<div class="archive">
+  <div class="archive-list">
+  {% if site.posts.size == 0 %}
+    <h2>No posts found</h2>
+  {% else %}
+
+  {% for post in paginator.posts %}
+    <div class="archive-list-item">
+      {% if post.link %}
+      <a href="{{ post.link }}">
+      {% else %}
+      <a href="{{ post.url | prepend: site.baseurl }}">
+      {% endif %}
+        <span class="archive-list-item-title">
+          {{ post.title }}
+        </span>
+        <span class="archive-list-item-date">
+          <time>| {{ post.date | date_to_string }}</time>
+        </span>
+      </a>
+    </div>
+  {% endfor %}
+  {% endif %}
+  </div>
+</div>

data/_layouts/default.html

@@ -5,7 +5,11 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     {%- seo -%}
+    {% feed_meta %}
     <link rel="stylesheet" href="{{ "/assets/css/style.css" | relative_url }}">
+    {% if site.css %}
+    <link rel="stylesheet" href="{{ site.css.src | relative_url }}">
+    {% endif %}
     <link rel="icon" type="image/png" sizes="32x32" href="{{ "/assets/img/logos/favicon-32x32.png" | relative_url }}">
     <link rel="icon" type="image/png" sizes="16x16" href="{{ "/assets/img/logos/favicon-16x16.png" | relative_url }}">
   </head>

data/_layouts/filtered-home.html

@@ -0,0 +1,21 @@
+---
+layout: default
+---
+
+<header>
+  <div class="header-small">
+    <a href="{{ site.url }}{{ site.baseurl }}">{{ site.title | escape }}</a>
+  </div>
+
+  <div class="page-title">{{ page.title | escape }}</div>
+</header>
+
+<div class="post-list">
+{% if site.posts.size == 0 %}
+  <h2>No posts found</h2>
+{% else %}
+
+{%- include post-list.html -%}
+
+{% endif %}
+</div>

data/_layouts/home.html

@@ -19,44 +19,7 @@ layout: default
   <h2>No posts found</h2>
 {% else %}
 
-{% for post in paginator.posts %}
-  <div class="post-list-item">
-    {% if post.link %}
-    <a href="{{ post.link }}">
-    {% else %}
-    <a href="{{ post.url | prepend: site.baseurl }}">
-    {% endif %}
-      <div class="post-list-item-date">
-        <time>{{ post.date | date_to_string }}</time>
-      </div>
-      <div class="post-list-item-title">
-        {{ post.title }}
-      </div>
-      {% if post.description %}
-      <div class="post-list-item-desc">
-        {{ post.description }}
-      </div>
-      {% endif %}
-    </a>
-  </div>
-{% endfor %}
-
-  <div class="post-list-pagination">
-    <span class="post-list-pagination-previous">
-      {% if paginator.previous_page %}
-        <a href="{{ paginator.previous_page_path | prepend: site.baseurl }}" class="previous">
-          &#60; previous
-        </a>
-      {% endif %}
-    </span>
+{%- include post-list.html -%}
 
-    <span class="post-list-pagination-next">
-      {% if paginator.next_page %}
-        <a href="{{ paginator.next_page_path | prepend: site.baseurl }}" class="next">
-          next &#62;
-        </a>
-      {% endif %}
-    </span>
-  </div>
 {% endif %}
 </div>

data/_layouts/post.html

@@ -18,6 +18,17 @@ layout: default
   <div class="page-content">
     {{ content }}
 
+    {% if page.tags.size > 0 %}
+    <div class="page-tags">
+      Tagged as
+      {% for tag in page.tags %}
+      <span class="page-tags-item">
+        {{ tag }}{% unless forloop.last %}, {% endunless %}
+      </span>
+      {% endfor %}
+    </div>
+    {% endif %}
+
     {% if site.isso.enabled %}
     <div class="comments-content">
       <section id="isso-thread"></section>

data/_sass/kiko-minus/_layout.scss

@@ -89,6 +89,12 @@
     margin-bottom: .5rem;
     @include relative-font-size(0.7);
   }
+
+  &-tags {
+    margin-top: 1.5rem;
+    @include relative-font-size(0.8);
+    color: lighten($base-font-color, 10%);
+  }
 }
 
 
@@ -130,7 +136,6 @@
   }
 
   &-pagination {
-    margin-top: 4rem;
     padding-top: 2rem;
     padding-bottom: 2rem;
     text-transform: lowercase;

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kiko-minus
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Areeb Khan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-25 00:00:00.000000000 Z
+date: 2019-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: jekyll-feed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: jekyll-paginate-v2
   requirement: !ruby/object:Gem::Requirement
@@ -120,7 +134,10 @@ files:
 - _includes/fathom.html
 - _includes/footer.html
 - _includes/isso.html
+- _includes/post-list.html
+- _layouts/archive.html
 - _layouts/default.html
+- _layouts/filtered-home.html
 - _layouts/home.html
 - _layouts/page.html
 - _layouts/post.html
@@ -131,15 +148,7 @@ files:
 - _sass/kiko-minus/_syntax-highlighting.scss
 - _sass/kiko-minus/_typography.scss
 - assets/css/style.scss
-- assets/img/black-holes/simulation.jpg
-- assets/img/logos/favicon-16x16.png
-- assets/img/logos/favicon-32x32.png
-- assets/img/style-test/golden-gate.jpg
-- assets/img_archive/favicon-16x16-2019-04-15-13-59-44-e9bf4e2f46cb5b94135c82ed11a7303c.png
-- assets/img_archive/favicon-32x32-2019-04-15-13-59-45-220710db31b5b79ecc3276beeb369e06.png
-- assets/img_archive/golden-gate-2019-04-15-23-14-57-9990487bd295197df7ce75e0c324bf0f.jpg
-- assets/img_archive/simulation-2019-04-15-23-05-22-f2c96ad2f54c8f230dc65870b3d0cbf1.jpg
-homepage: https://gitlab.com/areebk/kiko-minus
+homepage: https://github.com/ask616/kiko-minus
 licenses:
 - MIT
 metadata:
@@ -162,5 +171,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Stripped down version of Kiko Plus
+summary: A minimalistic, lightweight Jekyll theme based on Kiko Plus
 test_files: []