initial commit

Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'jekyll', '3.7.2'
+
+group :jekyll_plugins do
+  gem 'jekyll-archives', '2.1.1'
+  gem 'jekyll-extract-element', '0.0.7'
+  gem 'jekyll-feed', '0.9.3'
+  gem 'jekyll-seo-tag', '2.4.0'
+  gem 'jekyll-sitemap', '1.2.0'
+end

Gemfile.lock

@@ -0,0 +1,82 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.0.5)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.5)
+    ffi (1.9.18)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.6.0)
+    i18n (0.9.3)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.7.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
+      safe_yaml (~> 1.0)
+    jekyll-archives (2.1.1)
+      jekyll (>= 2.4)
+    jekyll-extract-element (0.0.7)
+      jekyll (~> 3.3)
+      nokogiri (= 1.8.2)
+    jekyll-feed (0.9.3)
+      jekyll (~> 3.3)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-seo-tag (2.4.0)
+      jekyll (~> 3.3)
+    jekyll-sitemap (1.2.0)
+      jekyll (~> 3.3)
+    jekyll-watch (2.0.0)
+      listen (~> 3.0)
+    kramdown (1.16.2)
+    liquid (4.0.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    mercenary (0.3.6)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    pathutil (0.16.1)
+      forwardable-extended (~> 2.6)
+    public_suffix (3.0.1)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rouge (3.1.1)
+    ruby_dep (1.5.0)
+    safe_yaml (1.0.4)
+    sass (3.5.5)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jekyll (= 3.7.2)
+  jekyll-archives (= 2.1.1)
+  jekyll-extract-element (= 0.0.7)
+  jekyll-feed (= 0.9.3)
+  jekyll-seo-tag (= 2.4.0)
+  jekyll-sitemap (= 1.2.0)
+
+BUNDLED WITH
+   1.16.0

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,78 @@
+# 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, themes and step-by-step Jekyll tutorials 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 --incremental
+```
+
+## 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,92 @@
+# ----
+# 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
+
+timezone: Etc/UTC
+
+permalink: /:categories/:title/
+
+plugins:
+  - jekyll-extract-element
+  - 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>