jekyll-docs 3.1.6 → 3.2.0

data/site/_docs/windows.md

@@ -1,46 +0,0 @@
----
-layout: docs
-title: Jekyll on Windows
-permalink: /docs/windows/
----
-
-While Windows is not an officially-supported platform, it can be used to run
-Jekyll with the proper tweaks. This page aims to collect some of the general
-knowledge and lessons that have been unearthed by Windows users.
-
-## Installation
-
-Julian Thilo has written up instructions to get
-[Jekyll running on Windows][windows-installation] and it seems to work for most
-people. The instructions were written for Ruby 2.0.0, but should work for later
-versions [prior to 2.2][hitimes-issue].
-
-Alternatively David Burela has written instructions on [how to install Jekyll via Chocolately with 3 command prompt entries](https://davidburela.wordpress.com/2015/11/28/easily-install-jekyll-on-windows-with-3-command-prompt-entries-and-chocolatey/).
-
-## Encoding
-
-If you use UTF-8 encoding, make sure that no `BOM` header
-characters exist in your files or very, very bad things will happen to
-Jekyll. This is especially relevant if you're running Jekyll on Windows.
-
-Additionally, you might need to change the code page of the console window to UTF-8
-in case you get a "Liquid Exception: Incompatible character encoding" error during
-the site generation process. It can be done with the following command:
-
-{% highlight bash %}
-$ chcp 65001
-{% endhighlight %}
-
-[windows-installation]: http://jekyll-windows.juthilo.com/
-[hitimes-issue]: https://github.com/copiousfreetime/hitimes/issues/40
-
-## Auto-regeneration
-
-As of v1.3.0, Jekyll uses the `listen` gem to watch for changes when the
-`--watch` switch is specified during a build or serve. While `listen` has
-built-in support for UNIX systems, it requires an extra gem for compatibility
-with Windows. Add the following to the Gemfile for your site:
-
-{% highlight ruby %}
-gem 'wdm', '~> 0.1.0' if Gem.win_platform?
-{% endhighlight %}

data/site/_includes/analytics.html

@@ -1,30 +0,0 @@
-{% if site.gauges_id %}
-  <!-- Gauges (http://gaug.es/) -->
-  <script>
-    var _gauges = _gauges || [];
-    (function() {
-      var t   = document.createElement('script');
-      t.type  = 'text/javascript';
-      t.async = true;
-      t.id    = 'gauges-tracker';
-      t.setAttribute('data-site-id', '{{ site.gauges_id }}');
-      t.src = '//secure.gaug.es/track.js';
-      var s = document.getElementsByTagName('script')[0];
-      s.parentNode.insertBefore(t, s);
-    })();
-  </script>
-{% endif %}
-
-{% if site.google_analytics_id %}
-  <!-- Google Analytics (http://google.com/analytics) -->
-  <script>
-    !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
-    (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
-    L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
-    L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
-
-    ga('create', '{{ site.google_analytics_id }}', 'jekyllrb.com');
-    ga('send', 'pageview');
-
-  </script>
-{% endif %}

data/site/_includes/anchor_links.html

@@ -1,33 +0,0 @@
-<script>
-  var anchorForId = function (id) {
-    var anchor = document.createElement("a");
-    anchor.className = "header-link";
-    anchor.href      = "#" + id;
-    anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
-    anchor.title = "Permalink";
-    return anchor;
-  };
-
-  var linkifyAnchors = function (level, containingElement) {
-    var headers = containingElement.getElementsByTagName("h" + level);
-    for (var h = 0; h < headers.length; h++) {
-      var header = headers[h];
-
-      if (typeof header.id !== "undefined" && header.id !== "") {
-        header.appendChild(anchorForId(header.id));
-      }
-    }
-  };
-
-  document.onreadystatechange = function () {
-    if (this.readyState === "complete") {
-      var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
-      if (!contentBlock) {
-        return;
-      }
-      for (var level = 1; level <= 6; level++) {
-        linkifyAnchors(level, contentBlock);
-      }
-    }
-  };
-</script>

data/site/_includes/docs_contents.html

@@ -1,8 +0,0 @@
-<div class="unit one-fifth hide-on-mobiles">
-  <aside>
-    {% for section in site.data.docs %}
-    <h4>{{ section.title }}</h4>
-    {% include docs_ul.html items=section.docs %}
-    {% endfor %}
-  </aside>
-</div>

data/site/_includes/docs_contents_mobile.html

@@ -1,10 +0,0 @@
-<div class="docs-nav-mobile unit whole show-on-mobiles">
-  <select onchange="if (this.value) window.location.href=this.value">
-    <option value="">Navigate the docs…</option>
-    {% for section in site.data.docs %}
-    <optgroup label="{{ section.title }}">
-      {% include docs_option.html items=section.docs %}
-    </optgroup>
-    {% endfor %}
-  </select>
-</div>

data/site/_includes/docs_option.html

@@ -1,11 +0,0 @@
-{% assign items = include.items %}
-
-{% for item in items %}
-  {% assign item_url = item | prepend:"/docs/" | append:"/" %}
-
-  {% for p in site.docs %}
-    {% if p.url == item_url %}
-      <option value="{{ site.url }}{{ p.url }}">{{ p.title }}</option>
-    {% endif %}
-  {% endfor %}
-{% endfor %}

data/site/_includes/docs_ul.html

@@ -1,17 +0,0 @@
-{% assign items = include.items %}
-
-<ul>
-{% for item in items %}
-  {% assign item_url = item | prepend:"/docs/" | append:"/" %}
-
-  {% if item_url == page.url %}
-    {% assign c = "current" %}
-  {% else %}
-    {% assign c = "" %}
-  {% endif %}
-
-  {% assign p = site.docs | where:"url",item_url | first %}
-  <li class="{{ c }}"><a href="{{ site.url }}{{ p.url }}">{{ p.title }}</a></li>
-
-{% endfor %}
-</ul>

data/site/_includes/footer.html

@@ -1,15 +0,0 @@
-<footer role="contentinfo">
-  <div class="grid">
-    <div class="unit one-third center-on-mobiles">
-      <p>The contents of this website are <br />&copy;&nbsp;{{ site.time | date: '%Y' }} under the terms of the <a href="{{ site.repository }}/blob/master/LICENSE">MIT&nbsp;License</a>.</p>
-    </div>
-    <div class="unit two-thirds align-right center-on-mobiles">
-      <p>
-        Proudly hosted by
-        <a href="https://github.com">
-          <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
-        </a>
-      </p>
-    </div>
-  </div>
-</footer>

data/site/_includes/header.html

@@ -1,18 +0,0 @@
-<header role="banner">
-  <nav class="mobile-nav show-on-mobiles">
-    {% include primary-nav-items.html %}
-  </nav>
-  <div class="grid">
-    <div class="unit one-third center-on-mobiles">
-      <h1>
-        <a href="/">
-          <span class="sr-only">Jekyll</span>
-          <img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
-        </a>
-      </h1>
-    </div>
-    <nav class="main-nav unit two-thirds hide-on-mobiles">
-      {% include primary-nav-items.html %}
-    </nav>
-  </div>
-</header>

data/site/_includes/news_contents.html

@@ -1,33 +0,0 @@
-<div class="unit one-fifth hide-on-mobiles">
-  <aside>
-    <ul>
-      <li class="{% if page.title == 'News' %}current{% endif %}">
-        <a href="/news/">All News</a>
-      </li>
-      <li class="{% if page.title == 'Releases' %}current{% endif %}">
-        <a href="/news/releases/">Jekyll Releases</a>
-      </li>
-    </ul>
-    <h4>Recent Releases</h4>
-    <ul>
-      {% for post in site.categories.release limit:5 %}
-      <li class="{% if page.title == post.title %}current{% endif %}">
-        <a href="{{ post.url }}">Version {{ post.version }}</a>
-      </li>
-      {% endfor %}
-      <li>
-        <a href="/docs/history/">History »</a>
-      </li>
-    </ul>
-    <h4>Other News</h4>
-    <ul>
-        {% for post in site.posts %}
-        {% unless post.categories contains 'release' %}
-        <li class="{% if page.title == post.title %}current{% endif %}">
-          <a href="{{ post.url }}">{{ post.title }}</a>
-        </li>
-        {% endunless %}
-        {% endfor %}
-    </ul>
-  </aside>
-</div>

data/site/_includes/news_contents_mobile.html

@@ -1,11 +0,0 @@
-<div class="docs-nav-mobile unit whole show-on-mobiles">
-  <select onchange="if (this.value) window.location.href=this.value">
-    <option value="">Navigate the blog…</option>
-    <option value="/news/">Home</option>
-    <optgroup label="v1.x">
-      {% for post in site.posts %}
-      <option value="{{ post.url }}">{{ post.title }}</option>
-      {% endfor %}
-    </optgroup>
-  </select>
-</div>

data/site/_includes/news_item.html

@@ -1,24 +0,0 @@
-<article>
-  <h2>
-    <a href="{{ post.url }}">
-      {{ post.title }}
-    </a>
-  </h2>
-  <span class="post-category">
-    <span class="label">
-      {{ post.categories | array_to_sentence_string }}
-    </span>
-  </span>
-  <div class="post-meta">
-    <span class="post-date">
-      {{ post.date | date_to_string }}
-    </span>
-    <a href="https://github.com/{{ post.author }}" class="post-author">
-      <img src="https://github.com/{{ post.author }}.png" class="avatar" alt="{{ post.author }} avatar" width="24" height="24">
-      {{ post.author }}
-    </a>
-  </div>
-  <div class="post-content">
-    {{ post.content }}
-  </div>
-</article>

data/site/_includes/primary-nav-items.html

@@ -1,17 +0,0 @@
-<ul>
-  <li class="{% if page.overview %}current{% endif %}">
-    <a href="/">Home</a>
-  </li>
-  <li class="{% if page.url contains '/docs/' %}current{% endif %}">
-    <a href="/docs/home/">Doc<span class="show-on-mobiles">s</span><span class="hide-on-mobiles">umentation</span></a>
-  </li>
-  <li class="{% if page.author %}current{% endif %}">
-    <a href="/news/">News</a>
-  </li>
-  <li>
-    <a href="/help/">Help</a>
-  </li>
-  <li>
-    <a href="{{ site.repository }}"><span class="hide-on-mobiles">View on </span>GitHub</a>
-  </li>
-</ul>

data/site/_includes/section_nav.html

@@ -1,39 +0,0 @@
-{% comment %}
-Map grabs the doc sections, giving us an array of arrays. Join, flattens all
-the items to a comma delimited string. Split turns it into an array again.
-{% endcomment %}
-{% assign docs = site.data.docs | map: 'docs' | join: ',' | split: ',' %}
-
-{% comment %}
-Because this is built for every page, lets find where we are in the ordered
-document list by comparing url strings. Then if there's something previous or
-next, lets build a link to it.
-{% endcomment %}
-
-{% for document in docs %}
-  {% assign document_url = document | prepend:"/docs/" | append:"/" %}
-  {% if document_url == page.url %}
-    <div class="section-nav">
-      <div class="left align-right">
-          {% if forloop.first %}
-            <span class="prev disabled">Back</span>
-          {% else %}
-            {% assign previous = forloop.index0 | minus: 1 %}
-            {% assign previous_page = docs[previous] | prepend:"/docs/" | append:"/" %}
-            <a href="{{ previous_page }}" class="prev">Back</a>
-          {% endif %}
-      </div>
-      <div class="right align-left">
-          {% if forloop.last %}
-            <span class="next disabled">Next</span>
-          {% else %}
-            {% assign next = forloop.index0 | plus: 1 %}
-            {% assign next_page = docs[next] | prepend:"/docs/" | append:"/" %}
-            <a href="{{ next_page }}" class="next">Next</a>
-          {% endif %}
-      </div>
-    </div>
-    <div class="clear"></div>
-    {% break %}
-  {% endif %}
-{% endfor %}

data/site/_includes/top.html

@@ -1,17 +0,0 @@
-<!DOCTYPE HTML>
-<html lang="en-US">
-<head>
-  <meta charset="UTF-8">
-  <title>{{ page.title }}</title>
-  <meta name="viewport" content="width=device-width,initial-scale=1">
-  <meta name="generator" content="Jekyll v{{ jekyll.version }}">
-  {% feed_meta %}
-  <link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="{{ site.repository }}/commits/master.atom">
-  <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
-  <link rel="stylesheet" href="/css/screen.css">
-  <link rel="icon" type="image/x-icon" href="/favicon.ico">
-  <!--[if lt IE 9]>
-  <script src="/js/html5shiv.min.js"></script>
-  <script src="/js/respond.min.js"></script>
-  <![endif]-->
-</head>

data/site/_layouts/default.html

@@ -1,13 +0,0 @@
-{% include top.html %}
-
-<body class="wrap">
-  {% include header.html %}
-
-  {{ content }}
-
-  {% include footer.html %}
-  {% include anchor_links.html %}
-  {% include analytics.html %}
-
-</body>
-</html>

data/site/_layouts/docs.html

@@ -1,26 +0,0 @@
----
-layout: default
----
-
-  <section class="docs">
-    <div class="grid">
-
-      {% include docs_contents_mobile.html %}
-
-      <div class="unit four-fifths">
-        <article>
-          <div class="improve right hide-on-mobiles">
-            <a href="https://github.com/jekyll/jekyll/edit/master/site/{{ page.path }}"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
-          </div>
-          <h1>{{ page.title }}</h1>
-          {{ content }}
-          {% include section_nav.html %}
-        </article>
-      </div>
-
-      {% include docs_contents.html %}
-
-      <div class="clear"></div>
-
-    </div>
-  </section>

data/site/_layouts/news.html

@@ -1,19 +0,0 @@
----
-layout: default
----
-
-  <section class="news">
-    <div class="grid">
-
-      {% include news_contents_mobile.html %}
-
-      <div class="unit four-fifths">
-        {{ content }}
-      </div>
-
-      {% include news_contents.html %}
-
-      <div class="clear"></div>
-
-    </div>
-  </section>

data/site/_layouts/news_item.html

@@ -1,27 +0,0 @@
----
-layout: news
----
-
-<article>
-  <h2>
-    {{ page.title }}
-    <a href="{{ page.url }}" class="permalink" title="Permalink">∞</a>
-  </h2>
-  <span class="post-category">
-    <span class="label">
-      {{ page.categories | array_to_sentence_string }}
-    </span>
-  </span>
-  <div class="post-meta">
-    <span class="post-date">
-      {{ page.date | date_to_string }}
-    </span>
-    <a href="https://github.com/{{ page.author }}" class="post-author">
-      <img src="https://github.com/{{ page.author }}.png" class="avatar" alt="{{ page.author }} avatar" width="24" height="24">
-      {{ page.author }}
-    </a>
-  </div>
-  <div class="post-content">
-    {{ content }}
-  </div>
-</article>

data/site/_layouts/page.html

@@ -1,18 +0,0 @@
----
-layout: default
----
-
-<section class="standalone">
-  <div class="grid">
-
-    <div class="unit whole">
-      <article>
-        <h1>{{ page.title }}</h1>
-        {{ content }}
-      </article>
-    </div>
-
-    <div class="clear"></div>
-
-  </div>
-</section>