init

.gitignore

@@ -0,0 +1,3 @@
+_site/
+.sass-cache/
+.jekyll-metadata

Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'jekyll', '3.4.3'
+
+group :jekyll_plugins do
+	gem 'jekyll-archives', '2.1.1'
+	gem 'jekyll-sitemap', '1.0.0'
+	gem 'jekyll-seo-tag', '2.1.0'
+	gem 'jekyll-feed', '0.9.1'
+	gem 'jekyll-extract-element', '0.0.6'
+end

Gemfile.lock

@@ -0,0 +1,68 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    colorator (1.1.0)
+    ffi (1.9.18)
+    forwardable-extended (2.6.0)
+    jekyll (3.4.3)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 3.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (~> 1.7)
+      safe_yaml (~> 1.0)
+    jekyll-archives (2.1.1)
+      jekyll (>= 2.4)
+    jekyll-extract-element (0.0.6)
+      jekyll (~> 3.3)
+      nokogiri (= 1.6.8)
+    jekyll-feed (0.9.1)
+      jekyll (~> 3.3)
+    jekyll-sass-converter (1.5.0)
+      sass (~> 3.4)
+    jekyll-seo-tag (2.1.0)
+      jekyll (~> 3.3)
+    jekyll-sitemap (1.0.0)
+      jekyll (~> 3.3)
+    jekyll-watch (1.5.0)
+      listen (~> 3.0, < 3.1)
+    kramdown (1.13.2)
+    liquid (3.0.6)
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    mercenary (0.3.6)
+    mini_portile2 (2.1.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    pathutil (0.14.0)
+      forwardable-extended (~> 2.6)
+    pkg-config (1.1.7)
+    public_suffix (2.0.5)
+    rb-fsevent (0.9.8)
+    rb-inotify (0.9.8)
+      ffi (>= 0.5.0)
+    rouge (1.11.1)
+    safe_yaml (1.0.4)
+    sass (3.4.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll (= 3.4.3)
+  jekyll-archives (= 2.1.1)
+  jekyll-extract-element (= 0.0.6)
+  jekyll-feed (= 0.9.1)
+  jekyll-seo-tag (= 2.1.0)
+  jekyll-sitemap (= 1.0.0)
+
+BUNDLED WITH
+   1.12.5

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 CloudCannon
+
+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.

README.md

@@ -0,0 +1,77 @@
+# Base
+
+Knowledge base template for Jekyll. Browse through a [live demo](https://orange-ape.cloudvent.net/).
+
+![Base template screenshot](images/_screenshot.png)
+
+Base was made by [CloudCannon](http://cloudcannon.com/), the Cloud CMS for Jekyll.
+Find more templates and themes at [Jekyll Tips](https://learn.cloudcannon.com/jekyll-templates/).
+
+Learn Jekyll with step-by-step tutorials and videos at [CloudCannon Academy](https://learn.cloudcannon.com/).
+
+## Features
+
+* Tutorials organised by category
+* Two types of tutorials - text and video
+* Ability to have a "tutorial series"
+* FAQ section
+* Disqus comments
+* Sticky sidebar for main headings in tutorials
+* Optimised for editing in [CloudCannon](http://cloudcannon.com/)
+* RSS/Atom feed
+* SEO tags
+* Google Analytics
+
+## Setup
+
+1. Add your site and author details in `_config.yml`.
+2. Add your Google Analytics, Disqus and MailChimp keys to `_config.yml`.
+3. Get a workflow going to see your site's output (with [CloudCannon](https://app.cloudcannon.com/) or Jekyll locally).
+
+## Develop
+
+Base was built with [Jekyll](http://jekyllrb.com/) version 3.4.3, but should support newer versions as well.
+
+Install the dependencies with [Bundler](http://bundler.io/):
+
+~~~bash
+$ bundle install
+~~~
+
+Run `jekyll` commands through Bundler to ensure you're using the right versions:
+
+~~~bash
+$ bundle exec jekyll serve
+~~~
+
+## Editing
+
+Base is already optimised for adding, updating and removing tutorials, navigation, footer and FAQ information in CloudCannon.
+
+The sticky sidebar in tutorials in populated by pulling out `<h2>` elements from the content.
+
+### Posts
+
+* Add, update or remove a post in the *Posts* collection.
+* The tutorials page is organised by categories.
+* Change the defaults when new posts are created in `_posts/_defaults.md`.
+
+### Post Series
+To create a new series:
+
+* Add a new document to the `sets` collection.
+* Set the `title` and `description`.
+
+To add a tutorial/post to a series:
+* Add a `set` field to the tutorial front matter which points to the file name of the desired set without the `.md` extention. e.g. If I have a set at `_sets/getting-started.md` I would use this in my tutorial front matter: `set: getting-started`.
+* Add a `set_order` field to the tutorial front matter and specify a number. This is the tutorials order in the set.
+
+### Navigation
+
+* Exposed as a data file to give clients better access.
+* Set in the *Data* / *Navigation* section.
+
+### Footer
+
+* Exposed as a data file to give clients better access.
+* Set in the *Data* / *Footer* section.

_config.yml

@@ -0,0 +1,88 @@
+# ----
+# Site
+
+title: Base
+url: "https://orange-ape.cloudvent.net/"
+baseurl:
+google_analytics_key:
+disqus_shortname:
+newsletter_action:
+
+# Values for the jekyll-seo-tag gem (https://github.com/jekyll/jekyll-seo-tag)
+logo: /siteicon.png
+description: Knowledge base template for Jekyll.
+author:
+  name:
+  email:
+  twitter: # twitter username without the @ symbol
+social:
+  name: Base Template
+  links:
+    - https://github.com/CloudCannon/base-jekyll-template
+
+# -----
+# Build
+
+permalink: /:categories/:title/
+
+gems:
+  - jekyll-sitemap
+  - jekyll-seo-tag
+  - jekyll-feed
+  - jekyll-archives
+
+exclude:
+  - Gemfile
+  - Gemfile.lock
+  - README.md
+  - LICENCE
+
+collections:
+  sets:
+
+
+jekyll-archives:
+  enabled: ['categories']
+
+defaults:
+  -
+    scope:
+      path: ""
+    values:
+      layout: "default"
+  -
+    scope:
+      type: "posts"
+    values:
+      layout: "post"
+      comments: true
+  -
+    scope:
+      type: "sets"
+    values:
+      _hide_content: true
+  -
+    scope:
+      path: "index.html"
+    values:
+      body_class: "show_hero_search"
+# -----------
+# CloudCannon
+
+social_icons:
+  - Facebook
+  - Google Plus
+  - Instagram
+  - LinkedIn
+  - Pinterest
+  - Tumblr
+  - Twitter
+  - YouTube
+  - Email
+  - RSS
+
+types:
+  - Document
+  - Video
+
+_comments:

_data/footer.yml

@@ -0,0 +1,16 @@
+- name:
+  link: https://facebook.com/
+  new_window: true
+  social_icon: Facebook
+- name:
+  link: https://twitter.com/
+  social_icon: Twitter
+  new_window: true
+- name:
+  link: https://youtube.com/
+  social_icon: YouTube
+  new_window: true
+- name: 
+  link: /feed.xml
+  social_icon: RSS
+  new_window: false

_data/navigation.yml

@@ -0,0 +1,6 @@
+- name: Tutorials
+  link: /
+- name: Videos
+  link: /videos/
+- name: FAQ
+  link: /faq/

_includes/document-icon.html

@@ -0,0 +1,12 @@
+{% case include.icon %}
+	{% when "Video" %}
+		<svg fill="#000000" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
+			<path d="M0 0h24v24H0z" fill="none"/>
+			<path d="M10 16.5l6-4.5-6-4.5v9zM12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm0 18c-4.41 0-8-3.59-8-8s3.59-8 8-8 8 3.59 8 8-3.59 8-8 8z"/>
+		</svg>
+	{% when "Document" %}
+		<svg fill="#000000" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
+			<path d="M6 2c-1.1 0-1.99.9-1.99 2L4 20c0 1.1.89 2 1.99 2H18c1.1 0 2-.9 2-2V8l-6-6H6zm7 7V3.5L18.5 9H13z"/>
+			<path d="M0 0h24v24H0z" fill="none"/>
+		</svg>
+{% endcase %}

_includes/footer.html

@@ -0,0 +1,15 @@
+<footer>
+	<div class="wrapper">
+		<p class="edit-footer"><a class="editor-link btn" href="cloudcannon:collections/_data/footer.yml" class="btn" style="padding: 5px;"><strong>&#9998;</strong> Edit footer</a></p>
+		<ul class="footer-links">
+			{% for link in site.data.footer %}
+				<li><a {% if link.new_window %}target="_blank"{% endif %} href="{% include relative-src.html src=link.link %}" {% if link.social_icon %}class="{{ link.social_icon }}-icon"{% endif %}>
+					{% if link.social_icon %}
+						{% include social-icon.html icon=link.social_icon %}
+					{% endif %}
+					{{ link.name }}</a></li>
+			{% endfor %}
+		</ul>
+		<p class="copyright">&copy; {{ site.title }} {{ site.time | date: "%Y" }}. All rights reserved.</p>
+	</div>
+</footer>

_includes/listings.html

@@ -0,0 +1,15 @@
+<ul class="listing">
+	{% for item in include.listings %}
+		<li {% if item.url == page.url %}class="active"{% endif %}>
+			<a href="{{ site.baseurl }}{{ item.url }}">
+				<div class="icon">{% include document-icon.html icon=item.type %}</div>
+				<article>
+					<div>
+						<h3>{% if include.numbered %}{{ forloop.index }}. {% endif %}{{ item.title }}</h3>
+						<p class="description">{{ item.description }}</p>
+					</div>
+				</article>
+			</a>
+		</li>
+	{% endfor %}
+</ul>

_includes/logo.html

@@ -0,0 +1,40 @@
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 width="68.375px" height="24px" viewBox="0 0 68.375 24" enable-background="new 0 0 68.375 24" xml:space="preserve">
+<path d="M4.59,6.89c0.7-0.71,1.4-1.35,1.71-1.22c0.5,0.2,0,1.03-0.3,1.52c-0.25,0.42-2.86,3.89-2.86,6.31
+	c0,1.28,0.48,2.34,1.34,2.98c0.75,0.56,1.74,0.729,2.64,0.459c1.07-0.31,1.95-1.399,3.06-2.77c1.21-1.49,2.83-3.44,4.08-3.44
+	c1.631,0,1.65,1.01,1.76,1.79c-3.779,0.641-5.379,3.67-5.379,5.371c0,1.699,1.44,3.09,3.209,3.09c1.631,0,4.291-1.33,4.69-6.101H21
+	v-2.5h-2.471c-0.149-1.65-1.09-4.2-4.029-4.2c-2.25,0-4.18,1.91-4.94,2.84c-0.58,0.73-2.06,2.48-2.29,2.72
+	c-0.25,0.3-0.68,0.84-1.11,0.84c-0.45,0-0.72-0.83-0.36-1.92c0.35-1.09,1.4-2.86,1.85-3.52C8.43,8,8.95,7.22,8.95,5.86
+	C8.95,3.69,7.31,3,6.44,3C5.12,3,3.97,4,3.72,4.25C3.36,4.61,3.06,4.91,2.84,5.18L4.59,6.89z M13.88,18.55
+	c-0.31,0-0.739-0.26-0.739-0.72c0-0.6,0.729-2.2,2.869-2.76C15.71,17.76,14.58,18.55,13.88,18.55z"/>
+<path fill="none" d="M0,0h24v24H0V0z"/>
+<g>
+	<path d="M30.864,8.79c1.336,0,2.373,0.456,3.112,1.368c0.739,0.913,1.109,2.204,1.109,3.873c0,1.67-0.373,2.968-1.118,3.893
+		c-0.746,0.924-1.78,1.387-3.104,1.387c-0.662,0-1.267-0.122-1.813-0.366c-0.548-0.245-1.007-0.62-1.378-1.128h-0.111l-0.325,1.309
+		h-1.104V4.689h1.54v3.507c0,0.786-0.024,1.491-0.074,2.115h0.074C28.391,9.297,29.454,8.79,30.864,8.79z M30.642,10.08
+		c-1.052,0-1.81,0.301-2.272,0.905c-0.465,0.603-0.696,1.619-0.696,3.047c0,1.43,0.238,2.451,0.714,3.066
+		c0.477,0.615,1.24,0.924,2.292,0.924c0.946,0,1.651-0.346,2.115-1.035s0.696-1.68,0.696-2.973c0-1.324-0.232-2.311-0.696-2.96
+		S31.612,10.08,30.642,10.08z"/>
+	<path d="M44.028,19.125l-0.306-1.447h-0.074c-0.508,0.637-1.014,1.068-1.518,1.294s-1.133,0.339-1.888,0.339
+		c-1.008,0-1.799-0.26-2.37-0.779c-0.572-0.52-0.858-1.258-0.858-2.217c0-2.054,1.642-3.13,4.927-3.229l1.725-0.057v-0.63
+		c0-0.798-0.171-1.387-0.515-1.767c-0.343-0.381-0.892-0.571-1.646-0.571c-0.848,0-1.806,0.26-2.876,0.779l-0.473-1.178
+		c0.5-0.272,1.049-0.485,1.646-0.64c0.597-0.154,1.195-0.232,1.795-0.232c1.212,0,2.11,0.269,2.695,0.807
+		c0.584,0.538,0.877,1.401,0.877,2.588v6.939H44.028z M40.549,18.039c0.959,0,1.712-0.262,2.26-0.788
+		c0.547-0.525,0.82-1.262,0.82-2.208v-0.918l-1.539,0.064c-1.225,0.043-2.108,0.233-2.649,0.57
+		c-0.541,0.338-0.812,0.861-0.812,1.572c0,0.557,0.168,0.98,0.506,1.271C39.472,17.895,39.943,18.039,40.549,18.039z"/>
+	<path d="M54.901,16.352c0,0.945-0.352,1.676-1.057,2.189s-1.695,0.77-2.969,0.77c-1.349,0-2.4-0.213-3.154-0.641v-1.428
+		c0.488,0.247,1.012,0.441,1.572,0.584c0.56,0.143,1.1,0.213,1.619,0.213c0.804,0,1.422-0.128,1.855-0.385
+		c0.433-0.256,0.648-0.647,0.648-1.174c0-0.395-0.171-0.734-0.515-1.016c-0.343-0.281-1.013-0.613-2.009-0.997
+		c-0.945-0.353-1.618-0.66-2.018-0.923c-0.398-0.264-0.695-0.562-0.891-0.896c-0.194-0.334-0.292-0.733-0.292-1.197
+		c0-0.829,0.337-1.483,1.011-1.962c0.675-0.479,1.6-0.719,2.774-0.719c1.095,0,2.165,0.223,3.21,0.668l-0.547,1.252
+		c-1.021-0.42-1.945-0.631-2.774-0.631c-0.729,0-1.28,0.115-1.651,0.343c-0.371,0.229-0.557,0.544-0.557,0.946
+		c0,0.272,0.069,0.504,0.209,0.696c0.139,0.192,0.363,0.375,0.672,0.547c0.31,0.174,0.903,0.424,1.781,0.752
+		c1.207,0.439,2.021,0.881,2.445,1.326C54.689,15.117,54.901,15.678,54.901,16.352z"/>
+	<path d="M61.701,19.311c-1.502,0-2.688-0.457-3.558-1.373c-0.869-0.915-1.304-2.186-1.304-3.812c0-1.639,0.404-2.941,1.211-3.906
+		c0.808-0.965,1.892-1.447,3.252-1.447c1.274,0,2.282,0.419,3.024,1.257c0.742,0.838,1.113,1.944,1.113,3.317v0.974h-7.005
+		c0.031,1.194,0.333,2.101,0.905,2.718c0.571,0.619,1.378,0.928,2.417,0.928c1.094,0,2.177-0.229,3.246-0.686v1.373
+		c-0.544,0.234-1.059,0.403-1.544,0.505C62.974,19.26,62.389,19.311,61.701,19.311z M61.284,10.061
+		c-0.816,0-1.468,0.266-1.953,0.798c-0.485,0.532-0.771,1.268-0.858,2.208h5.316c0-0.97-0.217-1.714-0.649-2.23
+		C62.707,10.319,62.088,10.061,61.284,10.061z"/>
+</g>
+</svg>