sparrow-jekyll-theme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7349aca7e9f1506bb304f59683e0eae8a184dc77
+  data.tar.gz: aec4bdbb31e5c3d94064087c2e0b67f4ea029750
+SHA512:
+  metadata.gz: 9d3bd5b460d489a8001ae5b5e8bf8970c6a1db54f1846dc593d9fe9693cb037d5fdbe86f8e8d05cd85e7a13b166ca85e35630dfef7fceb2d7c852c458effa064
+  data.tar.gz: 1f548527d6d1384c8f1683e3fda87f340a65f07877f62945c3c793842bbe4e56a07b49b5ab102c95a0cb3c848cc901b13d3b8b3332922277ed9b48a63f0a0e78

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Lingyi Hu
+
+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,162 @@
+# Sparrow
+
+A clean minimal Jekyll theme for writers. 
+
+[Live Demo](http://theconfused.me/sparrow)
+
+- [Features](#features)
+- [Why the name?](#why-the-name) 
+- [Install](#install)
+    - [General configuration](#general-configuration)
+    - [Disqus](#disqus)
+    - [Google analytics](#google-analytics)
+    - [Collections](#collections)
+    - [Pagination](#pagination)
+    - [Navigation](#navigation)
+    - [Front matter defaults](#front-matter-defaults)
+    - [Other](#other)
+- [Credits](#credits)
+
+## Screenshot 
+
+![](screenshot.png)
+
+## Features
+
+- Fully compatible with Github Pages
+- Configurable and responsive multi layer menu, adapted from [slimmenu](https://github.com/adnantopal/slimmenu)
+- Disqus integration
+- [Font Awesome icons](http://fontawesome.io/) included
+- Google analytics
+- Social sharing using [rrssb](https://www.rrssb.ml/)
+- 404 page included
+- Typographic optimization for Chinese fonts
+- Atom feed generated with [jekyll-feed](https://github.com/jekyll/jekyll-feed)
+- Pagination enabled for blog using [jekyll-paginate](https://github.com/jekyll/jekyll-paginate)
+- Basic SEO with Facebook Open Graph tags and Twitter cards
+
+## Why the name? 
+
+In Chinese there's a saying that goes 麻雀虽小，五脏俱全。It roughly translates to: small though a sparrow is, it possesses all internal organs. Small but complete is what this theme aspires to be. Minimal but includes all the essential aspects to building a blog. 
+
+## Install
+
+Just fork this repo and replace the posts with your own. Also rename the sample poetry collection to replace it with your own collection, or just delete it if you don't need to use collections. The example is poetry, but you can easily revamp this into essays, short stories, portfolio, or whatever your creative work is. 
+
+To run your site locally, do `bundle exec jekyll serve`. 
+
+For customization, see below. 
+
+### General configuration
+
+Customize these values in the `_config.yml` file: 
+
+```yaml
+title                    : "Sparrow"
+title_separator          : "-"
+description              : "A clean and minimal theme for writers."
+favicon                  : "/assets/images/bird.png"
+avatar                   : "/assets/images/bird.png"
+url                      : "https://theconfused.me" # the base hostname & protocol for your site e.g. "https://mmistakes.github.io"
+baseurl                  : "/sparrow" 
+
+# Site Author
+author:
+  name                   : "Lingyi" # appears in the footer and atom feed
+```
+
+
+### Disqus
+
+To activate Disqus, fill in your disqus shortname: 
+
+```yaml
+comments                 : true # set it to false to disable comments
+disqus:
+  shortname              : your_shortname
+```
+
+### Google analytics
+
+Enable google analytics by filling in your tracking ID: 
+
+```yaml
+analytics:
+  google:
+    tracking_id          : # add your google tracking id here
+```
+
+### Collections
+
+If you are using collections, be sure to replace this with your collection name: 
+
+```yaml
+collections:
+  poetry:
+    output: true
+    permalink: /:collection/:title/
+```
+
+### Pagination
+
+Currently, pagination is set to a the blog page. Unfortunately Jekyll does not yet support pagination on multiple pages. 
+
+If you want to paginate on a different page, simply change the `paginate_path` value in the config file and create the relevant page. 
+
+```yaml
+paginate: 5 # amount of posts to show
+paginate_path: "/blog/page:num/"
+timezone: # http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+```
+
+### Navigation
+
+You can change the navigation links in `_data/navigation.yml`.
+
+### Front matter defaults
+
+At the bottom of the config file, you can also set [front matter defaults](https://jekyllrb.com/docs/configuration/#front-matter-defaults) so that you don't have to repeat the same front matter for every post. This is an example: 
+
+```yaml
+# Front matter defaults
+defaults:
+  # _pages
+  - scope:
+      path: ""
+      type: pages
+    values:
+      layout: page
+      comments: false
+  # _posts
+  - scope:
+      path: ""
+      type: posts
+    values:
+      layout: post
+      comments: true
+      share: true
+  # _poetry
+  - scope:
+      path: ""
+      type: poetry
+    values:
+      layout: post
+      share: false
+```
+
+### Other
+
+To enhance SEO, you can add your twitter username to `_config.yml`. 
+
+You can also add a image path for the `og_image` value in the config file, for a default open graph sharing image. This value can be overridden in individual posts. 
+
+For the various config options see the [sample config file for the demo site](https://github.com/lingxz/sparrow/blob/master/_config.yml)
+
+There are also helper classes for ease of inserting image and their captions, adapted from the [Minimal Mistakes theme by Michael Rose](https://github.com/mmistakes/minimal-mistakes). You can find a [sample post with images](https://theconfused.me/sparrow/blog/post-with-image/) on the [demo site](https://theconfused.me/sparrow). 
+
+The color schemes and fonts can also be customized through scss, by editing the relevant variable in `_variables.scss`. 
+
+## Credits
+
+- Bird icon made by [Freepik](http://www.freepik.com) from [Flaticon](http://www.flaticon.com) and is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/).
+- Photos from [Unsplash](https://unsplash.com/)

data/_includes/analytics.html

@@ -0,0 +1,13 @@
+{% if site.analytics and page.analytics != false %}
+
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+  ga('create', '{{ site.analytics.google.tracking_id }}', 'auto');
+  ga('send', 'pageview');
+</script>
+
+{% endif %}

data/_includes/breadcrumbs.html

@@ -0,0 +1,32 @@
+{% if page.collection != 'posts' %}
+  {% assign path_type = nil %}
+  {% assign crumb_path = '/' %}
+{% else %}
+  {% assign crumb_path = site.categories.path %}
+{% endif %}
+
+<nav class="breadcrumbs">
+  <ol itemscope itemtype="http://schema.org/BreadcrumbList">
+    {% assign crumbs = page.url | split: '/' %}
+    {% assign i = 1 %}
+    {% for crumb in crumbs offset: 1 %}
+      {% if forloop.first %}
+        <li itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem">
+          <a href="{{ site.url }}{{ site.baseurl }}/" itemprop="item"><span itemprop="name">Home</span></a>
+          <meta itemprop="position" content="{{ i }}" />
+        </li>
+        <span class="sep">/</span>
+      {% endif %}
+      {% if forloop.last %}
+        <li class="current">{{ page.title }}</li>
+      {% else %}
+        {% assign i = i | plus: 1 %}
+        <li itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem">
+          <a href="{{ crumb | downcase | replace: '%20', '-' | prepend: path_type | prepend: crumb_path | absolute_url }}" itemprop="item"><span itemprop="name">{{ crumb | replace: '-', ' ' | replace: '%20', ' ' | capitalize }}</span></a>
+          <meta itemprop="position" content="{{ i }}" />
+        </li>
+        <span class="sep">/</span>
+      {% endif %}
+    {% endfor %}
+  </ol>
+</nav>

data/_includes/comments.html

@@ -0,0 +1,26 @@
+<div class="page__comments">
+
+  {% if site.disqus.shortname %}
+    <div id="disqus_thread"></div>
+    <script type="text/javascript">
+      var disqus_shortname = '{{ site.disqus.shortname }}';
+      var disqus_url = '{{ site.url }}/{{ page.url }}';
+
+      /* * * DON'T EDIT BELOW THIS LINE * * */
+      (function() {
+        var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+        dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+        (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+      })();
+
+      /* * * DON'T EDIT BELOW THIS LINE * * */
+      (function () {
+        var s = document.createElement('script'); s.async = true;
+        s.type = 'text/javascript';
+        s.src = '//' + disqus_shortname + '.disqus.com/count.js';
+        (document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
+      }());
+    </script>
+    <noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
+  {% endif %}
+</div>

data/_includes/figure

@@ -0,0 +1,12 @@
+<figure class="{{ include.class }}">
+  <img src=
+    {% if include.image_path contains "://" %}
+      "{{ include.image_path }}"
+    {% else %}
+      "{{ include.image_path | absolute_url }}"
+    {% endif %}
+    alt="{% if include.alt %}{{ include.alt }}{% endif %}">
+  {% if include.caption %}
+    <figcaption>{{ include.caption | markdownify | remove: "<p>" | remove: "</p>" }}</figcaption>
+  {% endif %}
+</figure>

data/_includes/paginator.html

@@ -0,0 +1,69 @@
+{% if paginator.total_pages > 1 %}
+<nav class="pagination">
+  {% assign first_page_path = site.paginate_path | replace: 'page:num', '' | replace: '//', '/' | absolute_url %}
+  <ul>
+    {% comment %} Link for previous page {% endcomment %}
+    {% if paginator.previous_page %}
+      {% if paginator.previous_page == 1 %}
+        <li><a href="{{ first_page_path }}">Previous</a></li>
+      {% else %}
+        <li><a href="{{ site.paginate_path | replace: ':num', paginator.previous_page | replace: '//', '/' | absolute_url }}">Previous</a></li>
+      {% endif %}
+    {% else %}
+    <li><a href="#" class="disabled"><span aria-hidden="true">Previous</span></a></li>
+    {% endif %}
+
+    {% comment %} First page {% endcomment %}
+    {% if paginator.page == 1 %}
+      <li><a href="#" class="disabled current">1</a></li>
+    {% else %}
+      <li><a href="{{ first_page_path }}">1</a></li>
+    {% endif %}
+
+    {% assign page_start = 2 %}
+    {% if paginator.page > 4 %}
+      {% assign page_start = paginator.page | minus: 2 %}
+      {% comment %} Ellipsis for truncated links {% endcomment %}
+      <li><a href="#" class="disabled">&hellip;</a></li>
+    {% endif %}
+
+    {% assign page_end = paginator.total_pages | minus: 1 %}
+    {% assign pages_to_end = paginator.total_pages | minus: paginator.page %}
+    {% if pages_to_end > 4 %}
+      {% assign page_end = paginator.page | plus: 2 %}
+    {% endif %}
+
+    {% for index in (page_start..page_end) %}
+      {% if index == paginator.page %}
+        <li><a href="{{ site.paginate_path | replace: ':num', index | replace: '//', '/' | absolute_url }}" class="disabled current">{{ index }}</a></li>
+      {% else %}
+        {% comment %} Distance from current page and this link {% endcomment %}
+        {% assign dist = paginator.page | minus: index %}
+        {% if dist < 0 %}
+          {% comment %} Distance must be a positive value {% endcomment %}
+          {% assign dist = 0 | minus: dist %}
+        {% endif %}
+        <li><a href="{{ site.paginate_path | replace: ':num', index | absolute_url }}">{{ index }}</a></li>
+      {% endif %}
+    {% endfor %}
+
+    {% comment %} Ellipsis for truncated links {% endcomment %}
+    {% if pages_to_end > 3 %}
+      <li><a href="#" class="disabled">&hellip;</a></li>
+    {% endif %}
+
+    {% if paginator.page == paginator.total_pages %}
+      <li><a href="#" class="disabled current">{{ paginator.page }}</a></li>
+    {% else %}
+      <li><a href="{{ site.paginate_path | replace: ':num', paginator.total_pages | replace: '//', '/' | absolute_url }}">{{ paginator.total_pages }}</a></li>
+    {% endif %}
+
+    {% comment %} Link next page {% endcomment %}
+    {% if paginator.next_page %}
+      <li><a href="{{ site.paginate_path | replace: ':num', paginator.next_page | replace: '//', '/' | absolute_url }}">Next</a></li></a></li>
+    {% else %}
+      <li><a href="#" class="disabled"><span aria-hidden="true">Next</span></a></li>
+    {% endif %}
+  </ul>
+</nav>
+{% endif %}

data/_includes/post-entry.html

@@ -0,0 +1,16 @@
+<div class="list__item">
+  <article class="page__item" itemscope itemtype="http://schema.org/CreativeWork">
+
+    <h3 class="page__item-title" itemprop="headline">
+      {% if post.link %}
+        <a href="{{ post.link }}">{{ post.title }}</a> <a href="{{ post.url | absolute_url }}" rel="permalink"><i class="fa fa-link" aria-hidden="true" title="permalink"></i><span class="sr-only">Permalink</span></a>
+      {% else %}
+        <a href="{{ post.url | absolute_url }}" rel="permalink">{{ post.title }}</a>
+      {% endif %}
+    </h3>
+
+    {% if post.date %}
+    <p class="page__meta"> <time datetime="{{ post.date | date_to_xmlschema }}">{{ post.date | date: "%B %d, %Y" }} </time></p>
+    {% endif %}
+  </article>
+</div>

data/_includes/seo.html

@@ -0,0 +1,77 @@
+<!-- begin SEO -->
+{% if site.url %}
+  {% assign seo_url = site.url | append: site.baseurl %}
+{% endif %}
+{% assign seo_url = seo_url | default: site.github.url %}
+
+{% if page.title %}
+  {% assign seo_title = page.title | append: " " | append: site.title_separator | append: " " | append: site.title %}
+{% endif %}
+
+{% if seo_title %}
+  {% assign seo_title = seo_title | markdownify | strip_html | strip_newlines | escape_once %}
+{% endif %}
+
+{% if site.url %}
+  {% assign canonical_url = page.url | replace: "index.html", "" | prepend: site.url %}
+{% endif %}
+
+<title>{{ seo_title | default: site.title }}{% if paginator %}{% unless paginator.page == 1 %} {{ site.title_separator }} {{ site.data.ui-text[site.locale].page | default: "Page" }} {{ paginator.page }}{% endunless %}{% endif %}</title>
+
+{% assign seo_description = page.description | default: page.excerpt | default: site.description %}
+{% if seo_description %}
+  {% assign seo_description = seo_description | markdownify | strip_html | strip_newlines | escape_once %}
+{% endif %}
+
+<meta name="description" content="{{ seo_description }}">
+
+{% assign seo_author = page.author | default: page.author[0] | default: site.author.name %}
+
+<meta name="author" content="{{ seo_author }}">
+
+<meta property="og:locale" content="{{ site.locale | replace: "-", "_" | default: "en_US" }}">
+<meta property="og:site_name" content="{{ site.title }}">
+<meta property="og:title" content="{{ page.title | default: site.title | markdownify | strip_html | strip_newlines | escape_once }}">
+
+{% if seo_url %}
+  <link rel="canonical" href="{{ page.url | prepend: seo_url | replace: "/index.html", "/" }}">
+  <meta property="og:url" content="{{ page.url | prepend: seo_url | replace: "/index.html", "/" }}">
+{% endif %}
+
+{% if page.excerpt %}
+  <meta property="og:description" content="{{ seo_description }}">
+{% endif %}
+
+{% if site.twitter.username %}
+  <meta name="twitter:site" content="@{{ site.twitter.username | replace: "@", "" }}">
+  <meta name="twitter:title" content="{{ page.title | default: site.title | markdownify | strip_html | strip_newlines | escape_once }}">
+  <meta name="twitter:description" content="{{ seo_description }}">
+  <meta name="twitter:url" content="{{ canonical_url }}">
+
+  <meta name="twitter:card" content="summary">
+  {% if page.og_image %}
+    <meta name="twitter:image" content="{% if page.header.image contains "://" %}{{ page.header.image }}{% else %}{{ page.header.image | absolute_url }}{% endif %}">
+  {% elsif site.og_image %}
+    <meta name="twitter:image" content="{{ site.og_image | absolute_url }}">
+  {% endif %}
+  <meta name="twitter:creator" content="@{{ site.twitter.username }}">
+{% endif %}
+
+{% if page.og_image %}
+  <meta property="og:image" content="{% if page.header.image contains "://" %}{{ page.header.image }}{% else %}{{ page.header.image | absolute_url }}{% endif %}">
+{% elsif site.og_image %}
+  <meta property="og:image" content="{% if site.og_image contains "://" %}{{ site.og_image }}{% else %}{{ site.og_image | absolute_url }}{% endif %}">
+{% endif %}
+
+{% if page.date %}
+  <meta property="og:type" content="article">
+  <meta property="article:published_time" content="{{ page.date | date_to_xmlschema }}">
+{% endif %}
+
+{% if paginator.previous_page %}
+  <link rel="prev" href="{{ paginator.previous_page_path | prepend: seo_url }}">
+{% endif %}
+{% if paginator.next_page %}
+  <link rel="next" href="{{ paginator.next_page_path | prepend: seo_url }}">
+{% endif %}
+