kiko-minus-gh 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cee31bff3ede50de034e7de34f556bbc2bc1fe2dfc04bd5c92b0604485350e83
+  data.tar.gz: 80050a927fef41842d81e898b951dd1192f3d0b6d05f6a9745f9389a7b6dd097
+SHA512:
+  metadata.gz: 41492a4083d0353b3111275f658fe27f86035729068ff0356cc63316dcba77d74aaa8e53ef331250eeeb491a80621fb7f94b8e5eb44dd2be607d84ad22c1827b
+  data.tar.gz: d993bc718d611365a2dbf961427d30b473c6bf906aa398459352e1d33ebea969dd4bfc6b0e2bf647ff6e3b74232771313a205df3c4699a5782f9d8782f4b3ec9

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Areeb Khan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,154 @@
+# kiko-minus
+
+[![Gem Version](https://badge.fury.io/rb/kiko-minus.svg)](https://badge.fury.io/rb/kiko-minus)
+
+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.
+
+[Demo](https://areebk.gitlab.io/kiko-minus/)
+
+![Screenshot](screenshot.png)
+
+## Features
+- Ready for use with GitLab or GitHub pages
+- Syntax highlighting
+- Automatic image compression
+- Zopfli compression (gzip)
+- Fully responsive
+- Automatic sitemap generation
+- 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
+
+You can use kiko-minus on your site after scaffolding with `jekyll new`:
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "kiko-minus"
+```
+
+Copy this [configuration](https://github.com/ask616/kiko-minus/blob/master/_config.yml) to your site's `_config.yml`.
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kiko-minus
+
+Finally, make sure to follow the directions [below](https://github.com/ask616/kiko-minus#pagination) to enable pagination on your home page.
+
+## 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
+
+### Pagination
+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:
+
+```
+pagination:
+  enabled: true
+```
+
+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).
+
+### 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.
+
+### Gzip Compression
+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:
+
+```
+JEKYLL_ENV=production bundle exec jekyll build
+```
+
+This is done because creating the bundles can be slow, and so should only be done in production mode.
+
+### 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 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
+
+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/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
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_includes/fathom.html

@@ -0,0 +1,13 @@
+<script>
+  (function(f, a, t, h, o, m){
+    a[h]=a[h]||function(){
+      (a[h].q=a[h].q||[]).push(arguments)
+    };
+    o=f.createElement("script"),
+    m=f.getElementsByTagName("script")[0];
+    o.async=1; o.src=t; o.id="fathom-script";
+    m.parentNode.insertBefore(o,m)
+  })(document, window, "{{ site.fathom.script_src }}", "fathom");
+  fathom("set", "siteId", "{{ site.fathom.site_id }}");
+  fathom("trackPageview");
+</script>

data/_includes/footer.html

@@ -0,0 +1,4 @@
+<div class="footer">
+  <hr />
+    © {{ site.copyright.year }} {{ site.copyright.name }}. All rights reserved.
+</div>

data/_includes/isso.html

@@ -0,0 +1,61 @@
+
+<script data-isso="{{ site.isso.prefix }}"
+        src="{{ site.isso.script_src }}"
+
+        {% if site.isso.css %}
+        data-isso-css="{{ site.isso.css }}"
+        {% endif %}
+
+        {% if site.isso.lang %}
+        data-isso-lang="{{ site.isso.lang }}"
+        {% endif %}
+
+        {% if site.isso.reply_to_self %}
+        data-isso-reply-to-self="{{ site.isso.reply_to_self }}"
+        {% endif %}
+
+        {% if site.isso.require_author %}
+        data-isso-require-author="{{ site.isso.require_author }}"
+        {% endif %}
+
+        {% if site.isso.require_email %}
+        data-isso-require-email="{{ site.isso.require_email }}"
+        {% endif %}
+
+        {% if site.isso.max_comments_top %}
+        data-isso-max-comments-top="{{ site.isso.max_comments_top }}"
+        {% endif %}
+
+        {% if site.isso.max_comments_nested %}
+        data-isso-max-comments-nested="{{ site.isso.max_comments_nested }}"
+        {% endif %}
+
+        {% if site.isso.reveal_on_click %}
+        data-isso-reveal-on-click="{{ site.isso.reveal_on_click }}"
+        {% endif %}
+
+        {% if site.isso.avatar %}
+        data-isso-avatar="{{ site.isso.avatar }}"
+        {% endif %}
+
+        {% if site.isso.avatar_bg %}
+        data-isso-avatar-bg="{{ site.isso.avatar_bg }}"
+        {% endif %}
+
+        {% if site.isso.avatar_fg %}
+        data-isso-avatar-fg="{{ site.isso.avatar_fg }}"
+        {% endif %}
+
+        {% if site.isso.vote %}
+        data-isso-vote="{{ site.isso.vote }}"
+        {% endif %}
+
+        {% if site.isso.vote_levels %}
+        data-isso-vote-levels="{{ site.isso.vote_levels }}"
+        {% endif %}
+
+        {% if site.isso.feed %}
+        data-isso-feed="{{ site.isso.feed }}"
+        {% endif %}
+        >
+</script>

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

@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en-US" }}">
+  <head>
+    <meta charset="utf-8">
+    <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>
+
+  <body>
+    <main class="page-content" aria-label="Content">
+      <div class="main-wrapper">
+        {{ content }}
+
+        {%- include footer.html -%}
+      </div>
+    </main>
+  </body>
+
+  {% if site.isso.enabled %}
+  {%- include isso.html -%}
+  {% endif %}
+
+  {% if site.fathom.enabled %}
+  {%- include fathom.html -%}
+  {% endif %}
+</html>

data/_layouts/home.html

@@ -0,0 +1,25 @@
+---
+layout: default
+---
+
+<header>
+  <div class="header-title">
+    <a href="{{ site.url }}{{ site.baseurl }}">{{ site.title }}</a>
+  </div>
+
+  <nav class="header-nav">
+    {% for nav in site.nav %}
+      <a href="{{ nav.url | prepend: site.baseurl }}">{{ nav.name }}</a>
+    {% endfor %}
+  </nav>
+</header>
+
+<div class="post-list">
+{% if site.posts.size == 0 %}
+  <h2>No posts found</h2>
+{% else %}
+
+{%- include post-list.html -%}
+
+{% endif %}
+</div>

data/_layouts/page.html

@@ -0,0 +1,17 @@
+---
+layout: default
+---
+
+<article class="page">
+  <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="page-content">
+    {{ content }}
+  </div>
+</article>

data/_layouts/post.html

@@ -0,0 +1,38 @@
+---
+layout: default
+---
+
+<article class="post">
+  <header>
+    <div class="header-small">
+      <a href="{{ site.url }}{{ site.baseurl }}">{{ site.title | escape }}</a>
+    </div>
+
+    <div class="page-title">{{ page.title | escape }}</div>
+
+    <span class="page-date">
+      <time>{{ page.date | date_to_string }}</time>
+    </span>
+  </header>
+
+  <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>
+    </div>
+    {% endif %}
+  </div>
+</article>