sparrow-jekyll-theme 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4095ddcf4e38f5fec08d8b9d9edf44b7cd135a77
-  data.tar.gz: b215e8c038a30942a5b9ce4c0733b02eb1d476eb
+  metadata.gz: a142040fe6cc8a6723b39197f3be2de73d1e795a
+  data.tar.gz: b24a64f2bc6bc1631ce19f16bd29620c6039805b
 SHA512:
-  metadata.gz: 2e953f08eaea325094cda06b91461dc32830f8b66a2cf4c71bd1d7e598937648794bbc889ed1b24d5447937872eb3d9dead036f05e590e46301fc92e66b61661
-  data.tar.gz: fcfdf82955532d1a8a806e53cd45608a5ceab415a0f4096510f657c6d093e8e1b5d45245b3065cd2fd5c8ca295c7f564178b832e24b920087a56b5a42ca16717
+  metadata.gz: 4321c9862aa7fe94820b37549422efb05282b6b5b09c917db991df07b48a0215c88806a573cf31c8cb13549d559e5ec01b2520113237bd1ad0ac8d2852239085
+  data.tar.gz: 3664dc14af02c6158b0bed3d2f7fb64180fc288c5923f1d8467b5132abd1d35c766a765b377dcaa3b464fd0ba49805b84c1571686b96f00ac14db419bcddd216

data/LICENSE.txt

@@ -1,21 +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
+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

@@ -1,178 +1,170 @@
-# Sparrow
-
-[![Gem Version](https://badge.fury.io/rb/sparrow-jekyll-theme.svg)](https://badge.fury.io/rb/sparrow-jekyll-theme)
-
-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. 
-
-OR you can also install this theme as a theme gem. To do that, add to your Gemfile: 
-
-```ruby
-gem "sparrow-jekyll-theme"
-```
-
-And add this line site's `_config.yml`: 
-
-```yaml
-theme: sparrow-jekyll-theme
-```
-
-And then do `bundle install`. 
-
-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/)
+# Sparrow
+
+[![Gem Version](https://badge.fury.io/rb/sparrow-jekyll-theme.svg)](https://badge.fury.io/rb/sparrow-jekyll-theme)
+
+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-v2](https://github.com/sverrirs/jekyll-paginate-v2)
+- 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. 
+
+OR you can also install this theme as a theme gem. To do that, add to your Gemfile: 
+
+```ruby
+gem "sparrow-jekyll-theme"
+```
+
+And add this line site's `_config.yml`: 
+
+```yaml
+theme: sparrow-jekyll-theme
+```
+
+And then do `bundle install`. 
+
+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
+
+Pagination is done using jekyll-paginate-v2. Currently it is only turned on for the blog page, but it could possibly support pagination on multiple pages. Please read the [jekyll-paginate-v2 documentation](https://github.com/sverrirs/jekyll-paginate-v2/blob/master/README-GENERATOR.md#creating-pagination-trails) for configuraiton. 
+
+### 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

@@ -1,13 +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 %}
+{% 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

@@ -1,32 +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>
+{% 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>