jekyll-theme-perry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ddc1e2dc676ad72fcbad166c2aa41972427a476d
+  data.tar.gz: c142a7e4a7710f15e55344dfcdf0e04e4ea19205
+SHA512:
+  metadata.gz: 15311760b14821488db6e065fe5abc19e072b9249c34dc6d6303527803ef3dd5f00b940933c07a2d65924daac5feab9ef82e9c6264f066c61d24ac5d263d7cc4
+  data.tar.gz: 6ce4ef5caa94e93a3635b36371a80c28a7ff3c40d08db1c63a6e898bef9b52b1a775b6051a9cc08e8f82f176dddec64b056071ac0761d8a580661c4ef01ec3b8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Richard Perry
+
+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,202 @@
+# jekyll-theme-perry
+
+This is a custom Jekyll theme used for my own websites, but anyone who likes it is welcome to make
+use of it for their own purposes. I have developed this as a hobby, the coding is not necessarily
+brilliant so if you want to use it, but have some suggestions as to how it could be improved, then
+please feel free to submit issues, pull/merge requests etc for me to look at. I can't guarantee I
+will make any changes, but I will certainly be interested to get feedback from better developers
+:smiley:
+
+## Installation
+
+Add this line to your Jekyll site's Gemfile:
+
+```ruby
+gem "jekyll-theme-perry"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-theme-perry
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-theme-perry
+
+## Features
+
+ * Responsive layout
+ * HTML5
+ * [Jekyll SEO Tag][seo] support
+ * [Jekyll Redirect From][red] support
+ * [Jekyll Archvies][arc] support
+ * [Post Series][ps] support
+
+## Usage
+
+Before making use of this theme, there are a number of settings that need to be added to the
+`_config.yml` file, and a couple of yaml files to be added to the `_data` directory.
+
+The following items need to be added to the `_config.yml` file otherwise there will be errors:
+
+ * `title` Your site title;
+ * `author` The global site author (more details below);
+ * `url` The full url of the website;
+ *  `gems: ['jekyll-seo-tag']` Essential gem used by the theme.
+
+The [Jekyll SEO Tag][seo] plugin is included to handle the SEO tags for the theme. If it is not 
+included in the `gems` list then the theme will fail.
+
+The navigation menu is generated based on a yaml file in the `_data` folder. The file needs to be 
+named `links.yml` and the format is as follows:
+
+```yaml
+- url: /
+  title: Home
+- url: /blog
+  title: Blog
+  sub:
+  - url: /blog/jekyll
+    title: Jekyll
+  - url: /blog/technology
+    title: Technology
+- url: /about
+  title: About Me
+```
+
+Author information needs to be included in the file `_data\authors.yml` and can be leveraged in much
+the same way as it is by the [Jekyll SEO Tag][seo] plugin as detailed [here][s-conf], although much
+more detail has been included in this theme so the following options are available for use on author
+pages:
+
+```yaml
+richard:
+  name: Richard Perry 
+  about: 
+  email: 
+  web: 
+  facebook:
+  flickr: 
+  github: 
+  gravatar: 
+  google: 
+  instagram:
+  linkedin: 
+  twitter:  
+```
+
+That's all that needs to be done to get the theme up and running, but that's not all there is. The
+theme has built in support for the [Jekyll Archives][arc] and [Jekyll Redirect From][red] gems with
+a layouts for both included by default. To make use of these plugins, you need to include the gems
+in your `_config.yml` file. The gems section should now something like this:
+
+```yaml
+gems:
+  - jekyll-seo-tag
+  - jekyll-archives
+  - jekyll-redirect-from
+```
+
+Or
+
+```yaml
+gems: ['jekyll-seo-tag','jekyll-archives','jekyll-redirect-from']
+```
+
+In the page footer, you can include copyright information, a 'Powered by Jekyll' attribution and a
+'Hosted by' attribution. All you need to do is include the following in your `_config.yml` file:
+
+```yaml
+meta:             
+  copyright:
+    year:           '2009' # First year of copyright attribution, this will show 2009 - 2017
+  powered-by:     true
+  hosting:          
+    name:         GitHub Pages
+    link:         //pages.github.com/
+```
+
+The copyright year is the year you want the copyright to start from. The copyright attribution will
+use `site.data.authors[site.author].name`, so set that appropriately. If you just want the copyright
+to display the current year then it should be set to `copyright: true` with no year.
+
+Also, you can include a logo as part of your header with the `logo` tag in your `_config.yml` file.
+
+### Archives
+
+Archive pages for Categories, Tags, Year, Month & Day can all be automatically generated through the
+[Jekyll Archives][arc] gem as mentioned above, and the theme includes a single layout for them all
+(this can be overidden with your own `archive.html` layout file, or using the [Jekyll Archives][arc]
+configuration settings). To make use of the plugin, you need to add the configuration options
+relevant to you. Further information on this can be found [here][a-conf].
+
+This theme also has support for generating lists of posts organised by date in reverse order for use
+as additional archives. The posts are listed and grouped by year and month. This feature can be used
+on any page by putting `{% include archives.html %}` within any loop i.e.
+
+```yaml
+{% for post in site.posts %}
+    {% include archives.html %}    
+{% endfor %}
+```
+
+### Post Series
+
+There is also support for creating post series with quick links to the other posts in the series (Of
+course, you could just use Categories and/or Tags for this as the [Jekyll Archives][arc] plugin
+creates the archive pages for these already). To make use of this feature you will need to add a
+`_data\series.yml` file using the following format:
+
+```yaml
+- name: "Migrating to Jekyll"
+  description: "At the back end of last year, I started migrating my website to Jekyll. This series
+    details my journey through that."
+  image: "/assets/images/jekyll.png"
+  copyright: "Copyright &copy; 2017 <a href='//jekyllrb.com/' title='Jekyll'>Jekyll</a>"
+  permalink: /series/jekyll/
+  start: "2014-03-18 19:30:00+00:00"
+  end: "2014-04-14 21:00:00+00:00"
+```
+Then to add a post to the series simply add `series: Migrating to Jekyll` to the frontmatter. Then
+to create a page to list all posts in the series in chronological order create a page with the same
+line in the frontmatter and a layout of `series`. Post summaries for each post in the series will
+then be included at the bottom of the page displayed with the oldest post first.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at 
+https://github.com/richardp2/jekyll-theme-perry. This project is intended to be a safe, welcoming
+space for collaboration, and contributors are expected to adhere to the
+[Contributor Covenant][contrib] 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`
+tracked with Git will be released.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License][mit].
+
+[seo]: //github.com/jekyll/jekyll-seo-tag
+[s-conf]: //github.com/jekyll/jekyll-seo-tag#author-information
+[arc]: //github.com/jekyll/jekyll-archives
+[a-conf]: //github.com/jekyll/jekyll-archives/blob/master/docs/configuration.md
+[red]: //github.com/jekyll/jekyll-redirect-from
+[contrib]: //contributor-covenant.org
+[mit]: //opensource.org/licenses/MIT
+[ps]: #post-series

data/_includes/archives.html

@@ -0,0 +1,13 @@
+            {% capture this_year %}{{ post.date | date: "%Y" }}{% endcapture %}
+            {% unless year == this_year %}
+            {% assign year = this_year %}
+            <h2 class='year'><a href='/archives/{{ year }}/'>{{year}}</a></h2>
+            {% endunless %}
+
+            {% capture this_month %}{{ post.date | date: "%B%Y" }}{% endcapture %}
+            {% unless month == this_month %}
+            {% assign month = this_month %}
+            <h3 class='month'>{{ post.date | date: "%B" }}</h3>
+            {% endunless %}
+
+            <li><span class='day'>{{ post.date | date:"%d" }}</span> <a href="{{ post.url }}">{{ post.title }}</a></li>

data/_includes/feed_content.html

@@ -0,0 +1,7 @@
+{% case post.layout %}
+  {% when 'video' %}
+    <iframe width="560" height="315" src="//www.youtube.com/embed/{{post.video}}?rel=0" frameborder="0" allowfullscreen></iframe>
+    {{ post.content }}   
+  {% else %}
+    {{ post.content }}
+{% endcase %}

data/_includes/foot-scripts.html

@@ -0,0 +1,12 @@
+
+{% if page.comments %}
+{% capture identifier %}{% if page.wordpress_id %}{{ page.wordpress_id }}{% else %}{{ page.url }}{% endif %}{% endcapture %}
+<script defer type="text/javascript">var disqus_shortname="{{ site.disqus.shortname }}",disqus_identifier="{{ identifier }}",disqus_url="http://richard.perry-online.me.uk{{ page.url }}";!function(){var e=document.createElement("script");e.type="text/javascript",e.async=!0,e.src="http://"+disqus_shortname+".disqus.com/embed.js",(document.getElementsByTagName("head")[0]||document.getElementsByTagName("body")[0]).appendChild(e)}();</script>
+<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
+<a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
+{% endif %}
+<script defer src="//ajax.googleapis.com/ajax/libs/jquery/1.10.1/jquery.min.js"></script>
+<!-- <script>window.jQuery || document.write('<script src="/assets/scripts/vendor/jquery-1.10.1.min.js"><\/script>')</script> -->
+<!--<script defer src="/assets/scripts/vendor/jquery.slicknav.min.js"></script> -->
+<script defer src="/assets/scripts/vendor/jquery.colorbox.min.js"></script>
+<script defer src="/assets/scripts/main.min.js"></script>

data/_includes/full-social.html

@@ -0,0 +1,8 @@
+<div class='social'>{% for social in site.data.social %}{% assign author = site.data.authors[page.author] %}
+  {% if author[social.name] %}<span class="fa-stack fa-lg">
+    <a href='{{social.link}}{{author[social.name]}}' title='{{social.title}}'>
+      <i class="fa fa-circle fa-stack-2x"></i>
+      <i class="fa {{social.fa-icon}} fa-stack-1x fa-inverse"></i>
+    </a>
+  </span>{% endif %}{% endfor %}
+</div>

data/_includes/meta.html

@@ -0,0 +1,21 @@
+{% if post.author %}{% assign author = site.data.authors[post.author] %}{% else %}{% assign author = site.data.authors[site.author] %}{% endif %}
+            <span class='meta'>
+                <i class='fa fa-clock-o'></i><time itemprop='datePublished' content='{{ post.date | date: '%F' }}' datetime='{{ post.date | date_to_xmlschema }}'> {{ post.date | date: "%d %b %Y" }}</time>
+                &nbsp; | &nbsp;
+                <i class='fa fa-user'></i> <span itemprop='author'><a href='//www.perry-online.me.uk/author/{{ author.name | downcase | replace: '& ', '' | replace: ' ', '-' }}/' title='{{ author.name }}'>{{ author.name }}</a></span>
+
+                {% if post.categories.size > 0 %} &nbsp; | &nbsp; 
+                <i class='fa fa-folder-open'></i> <span itemprop='keywords'>{% for category in post.categories %}
+                    <a href='/{{ category }}/' class="{{ category }}">{{ site.post_categories[category].name }}</a>{% unless forloop.last %}, {% endunless %}{% endfor %}
+                </span>{% endif %}
+
+                {% if post.tags.size > 0 %} &nbsp; | &nbsp; 
+                <i class='fa fa-tags'></i> <span itemprop='keywords'>{% for tag in post.tags %}
+                    <a href='/tags/{{ tag | slugify }}/' class="{{ tag }}">{{ tag }}</a>{% unless forloop.last %}, {% endunless %}{% endfor %}
+                </span>{% endif %}
+
+                {% if post.locations %} &nbsp; | &nbsp; 
+                <i class='fa fa-map-marker'></i> <span itemprop='keywords'>{% for location in post.locations %}
+                    <a class="location" href="{{ site.locations[location].link }}">{{ site.locations[location].name }}</a>{% unless forloop.last %}, {% endunless %}{% endfor %}
+                </span>{% endif %}
+            </span>

data/_includes/nav.html

@@ -0,0 +1,3 @@
+            <ul{% if include.class %} class="{{ include.class }}"{% endif %}>{% for link in include.links %}
+                <li itemprop='name'><a href="{{ link.url }}" title="{{ link.title }}" {% if page.title == link.title %}class="current-page"{% endif %} itemprop='url'>{{ link.title }}</a>{% if link.sub %}{% include nav.html links=link.sub %}{% endif %}</li>
+            {% endfor %}</ul>

data/_includes/post-nav.html

@@ -0,0 +1,4 @@
+          <div class='post-nav'>{% if page.previous.url %}
+            <span class='alignleft'><a href='{{page.previous.url}}'><i class='fa fa-chevron-left'></i> {{ page.previous.title | truncatewords: 5 }}</a></span>{% endif %}{% if page.next.url %}
+            <span class='alignright'><a href='{{page.next.url}}'>{{ page.next.title | truncatewords: 5 }} <i class='fa fa-chevron-right'></i></a></span>{% endif %}
+          </div>

data/_includes/series.html

@@ -0,0 +1,9 @@
+{% assign post_series = site.data.series[page.series] %}{% assign series = '' %}{% for post in site.posts %}{% if post.url == page.url %}{% assign series = post.series %}{% endif %}{% endfor %}  
+<div class="series_list">
+	<h4>{{ series }}</h4>
+	<ol>{% for post in site.posts reversed %}{% if post.series == series %}  
+		<li>{% if page.url == post.url %}{{post.title}}{% else %}<a href="{{post.url}}">{{post.title}}</a>{% endif %}</li>{% endif %}{% endfor %}  
+	</ol>
+</div>
+
+{% assign post_series = '' %}{% assign series = '' %}

data/_includes/summary.html

@@ -0,0 +1,36 @@
+{% capture icon %}
+    {% case post.format %}
+        {% when 'gallery' or 'image' %}
+            <i class='fa fa-picture-o'></i> 
+        {% when 'video' %}
+            <i class='fa fa-film'></i> 
+        {% when 'link' %}
+            <i class='fa fa-link'></i> 
+        {% else %}
+            
+    {% endcase %}
+{% endcapture %}
+                <header>
+                    <h2 itemprop='headline'>
+                        <a href='{{ post.url }}' itemprop='url'>
+                            {{ icon }}{{ post.title }}
+                        </a>
+                    </h2>
+                    {% include meta.html %}
+                </header>
+
+                <section itemProp='articleBody'>
+                {% if post.format == "gallery" %}
+                    {{ post.excerpt }}
+                    This Gallery contains {{ post.images }} photos.
+                {% else %}
+                    {% if post.video %}<iframe width='560' height='315' src='//www.youtube.com/embed/{{post.video}}?rel=0' frameborder='0' allowfullscreen itemProp='video'></iframe><br/>{% endif %}
+                    {% if post.image %}<img src="{{ post.image }}" title="{{ post.title }}" alt="{{ post.title }}" class='alignleft' />{% endif %}
+                    {{ post.content | markdownify | strip_html | truncatewords: 125 }}
+                {% endif %}
+                </section>
+                        
+                <footer>
+                    <a class='read-more' href='{{ post.url }}' itemprop='url'>read more <i class='fa fa-chevron-right'></i></a>
+                </footer>
+                    

data/_layouts/archive.html

@@ -0,0 +1,25 @@
+---
+layout: default
+---
+{% capture title %}
+    {% case page.type %}
+        {% when 'tag' or 'category' %}{{ page.type | capitalize }}: {{ page.title }}
+        {% when 'year' %}Archives: {{ page.date | date: "%Y" }}
+        {% when 'month' %}Archives: {{ page.date | date: "%B %Y" }}
+        {% when 'day' %}Archvies: {{ page.date | date: "%d %b %Y" }}
+    {% endcase %}
+{% endcapture %}
+            <article itemscope itemtype="//schema.org/Article" class="page">
+                <header>
+                    <h1 itemProp="headline">{{ title }}</h1>
+                </header>
+                
+                <section class="post-content" itemProp="articleBody">
+                    <ul id='archive'>
+                    {% for post in page.posts %}
+                        {% include archives.html %}  
+                    {% endfor %}
+                    </ul>
+                </section><!-- .post-content -->
+            </article><!-- .page -->
+

data/_layouts/default.html

@@ -0,0 +1,80 @@
+<!DOCTYPE html>{% capture title %}{% if page.title == 'Home' %} {{ site.title }} | {{ site.description }}{% else %}{{ page.title }} | {{ site.title }}{% endif %}{% endcapture %}{% if page.author %}{% assign auth = site.data.authors[page.author] %}{% else %}{% assign auth = site.data.authors[site.author] %}{% endif %}{% assign copyname = site.data.authors[site.author].name %}{% capture year %}{{ site.time | date: '%Y' }}{% endcapture %}{% capture copyright %}Copyright &copy; {% unless site.meta.copyright.year and year == site.meta.copyright.year %}{{ site.meta.copyright.year }} - {% endunless %}{{ year }} {{ copyname }}{% endcapture %}
+<html xmlns="http://www.w3.org/1999/xhtml" prefix="og: http://ogp.me/ns# fb: http://www.facebook.com/2008/fbml# article: http://ogp.me/ns/article#" lang='en-GB'>
+    <head>
+        <title>{{title}}</title>
+
+        <meta charset='utf-8'>
+        <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
+        <meta http-equiv='X-Clacks-Overhead' content='GNU Terry Pratchett'>
+        <meta name='author' content='{{auth.name}}'>
+        <meta name='viewport' content='width=device-width, initial-scale=1'>
+
+        <link href='https://fonts.googleapis.com/css?family=Indie+Flower|Lato:400,400i,900,900i&subset=latin-ext' rel='stylesheet'>
+        <link rel='stylesheet' href='/assets/css/style.css'>
+        <link rel='alternate' href='{{site.url}}/feed.xml' type='application/rss+xml' title='{{ site.title }}'>
+        <link rel='author' href='https://plus.google.com/{{auth.google}}'>
+
+        <script defer src='/assets/scripts/vendor/modernizr-2.6.2-respond-1.1.0.min.js'></script>
+
+        {% seo title=false %}
+    </head>
+
+    <body>
+        <header role='banner' itemscope itemtype='//schema.org/WPHeader'>
+            <h1 class='site-title'>{% if site.logo %}{% if site.logo contains 'svg' %}<object type='image/svg+xml' data='{{ site.logo }}' title='{{ site.title }}' name='{{ site.title }} Logo'>{{ site.title }}</object>{% else %}<img src='{{ site.logo }}' title='{{ site.title }}' alt='{{ site.title }} Logo' />{% endif %}{% else %}{{ site.title }}{% endif %}</h1>
+            {% if site.description %}<p class='site-description'>{{ site.description }}</p>{% endif %}
+        </header>
+
+        <nav itemscope itemtype='//schema.org/SiteNavigationElement'>
+            {% include nav.html links=site.data.links class='main-menu' %}
+        </nav><!-- #primary-navigation -->
+
+        <main itemscope itemtype='//schema.org/Blog'>
+
+            {{ content }}
+
+        </main><!-- #main-content -->
+                
+        <footer role='contentinfo' itemscope itemtype='//schema.org/WPFooter'>{% assign author = site.data.authors[site.author] %}
+            <div class='social'>
+                {% if author.facebook %}<span class='fa-stack fa-2x'>
+                    <a href='//www.facebook.com/{{author.facebook}}' title='Facebook'>
+                        <i class='fa fa-circle fa-stack-2x'></i>
+                        <i class='fa fa-facebook fa-stack-1x fa-inverse'></i>
+                    </a>
+                </span>{% endif %}
+                {% if author.twitter %}<span class='fa-stack fa-2x'>
+                    <a href='//twitter.com/{{author.twitter}}' title='Twitter'>
+                        <i class='fa fa-circle fa-stack-2x'></i>
+                        <i class='fa fa-twitter fa-stack-1x fa-inverse'></i>
+                    </a>
+                </span>{% endif %}
+                {% if author.github %}<span class='fa-stack fa-2x'>
+                    <a href='//github.com/{{author.github}}' title='GitHub'>
+                        <i class='fa fa-circle fa-stack-2x'></i>
+                        <i class='fa fa-github-alt fa-stack-1x fa-inverse'></i>
+                    </a>
+                </span>{% endif %}
+                {% if author.email %}<span class='fa-stack fa-2x'>
+                    <a href='mai&#108;to&#58;{{author.email}}' title='Email'>
+                        <i class='fa fa-circle fa-stack-2x'></i>
+                        <i class='fa fa-envelope fa-stack-1x fa-inverse'></i>
+                    </a>
+                </span>{% endif %}
+                <span class='fa-stack fa-2x'>
+                    <a href='/feed.xml' title='RSS Feed'>
+                        <i class='fa fa-circle fa-stack-2x feed'></i>
+                        <i class='fa fa-rss fa-stack-1x fa-inverse'></i>
+                    </a>
+                </span>
+            </div>{% if site.meta %}
+            <span class='site-meta'>
+                {% if site.meta.copyright %}<small class='copyright'>{{ copyright }}</small>{% endif %}
+                {% if site.meta.powered-by %}<small>Powered by <a href='//jekyllrb.com/' title='Jekyll &bull; Simple, blog-aware, static sites'>Jekyll</a></small> {% endif %}
+                {% if site.meta.hosting %}<small>Hosted at <a href='{{ site.meta.hosting.link }}' title='{{ site.meta.hosting.name }}'>{{ site.meta.hosting.name }}</a></small>{% endif %}
+            </span>{% endif %}
+        </footer><!-- #page-footer -->
+            
+        {% include foot-scripts.html %}
+    </body>
+</html>