Skip to content
This repository was archived by the owner on Jun 26, 2024. It is now read-only.

Commit 35e75d4

Browse files
mneumegenMike Neumegen
mneumegen
authored and
Mike Neumegen
committed
init
0 parents  commit 35e75d4

File tree

85 files changed

+5744
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+5744
-0
lines changed

‎.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
_site/
2+
.sass-cache/
3+
.jekyll-metadata

‎Gemfile

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
source 'https://rubygems.org'
2+
3+
gem 'jekyll', '3.4.3'
4+
5+
group :jekyll_plugins do
6+
gem 'jekyll-archives', '2.1.1'
7+
gem 'jekyll-sitemap', '1.0.0'
8+
gem 'jekyll-seo-tag', '2.1.0'
9+
gem 'jekyll-feed', '0.9.1'
10+
gem 'jekyll-extract-element', '0.0.6'
11+
end

‎Gemfile.lock

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.5.0)
5+
public_suffix (~> 2.0, >= 2.0.2)
6+
colorator (1.1.0)
7+
ffi (1.9.18)
8+
forwardable-extended (2.6.0)
9+
jekyll (3.4.3)
10+
addressable (~> 2.4)
11+
colorator (~> 1.0)
12+
jekyll-sass-converter (~> 1.0)
13+
jekyll-watch (~> 1.1)
14+
kramdown (~> 1.3)
15+
liquid (~> 3.0)
16+
mercenary (~> 0.3.3)
17+
pathutil (~> 0.9)
18+
rouge (~> 1.7)
19+
safe_yaml (~> 1.0)
20+
jekyll-archives (2.1.1)
21+
jekyll (>= 2.4)
22+
jekyll-extract-element (0.0.6)
23+
jekyll (~> 3.3)
24+
nokogiri (= 1.6.8)
25+
jekyll-feed (0.9.1)
26+
jekyll (~> 3.3)
27+
jekyll-sass-converter (1.5.0)
28+
sass (~> 3.4)
29+
jekyll-seo-tag (2.1.0)
30+
jekyll (~> 3.3)
31+
jekyll-sitemap (1.0.0)
32+
jekyll (~> 3.3)
33+
jekyll-watch (1.5.0)
34+
listen (~> 3.0, < 3.1)
35+
kramdown (1.13.2)
36+
liquid (3.0.6)
37+
listen (3.0.8)
38+
rb-fsevent (~> 0.9, >= 0.9.4)
39+
rb-inotify (~> 0.9, >= 0.9.7)
40+
mercenary (0.3.6)
41+
mini_portile2 (2.1.0)
42+
nokogiri (1.6.8)
43+
mini_portile2 (~> 2.1.0)
44+
pkg-config (~> 1.1.7)
45+
pathutil (0.14.0)
46+
forwardable-extended (~> 2.6)
47+
pkg-config (1.1.7)
48+
public_suffix (2.0.5)
49+
rb-fsevent (0.9.8)
50+
rb-inotify (0.9.8)
51+
ffi (>= 0.5.0)
52+
rouge (1.11.1)
53+
safe_yaml (1.0.4)
54+
sass (3.4.23)
55+
56+
PLATFORMS
57+
ruby
58+
59+
DEPENDENCIES
60+
jekyll (= 3.4.3)
61+
jekyll-archives (= 2.1.1)
62+
jekyll-extract-element (= 0.0.6)
63+
jekyll-feed (= 0.9.1)
64+
jekyll-seo-tag (= 2.1.0)
65+
jekyll-sitemap (= 1.0.0)
66+
67+
BUNDLED WITH
68+
1.12.5

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2017 CloudCannon
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Base
2+
3+
Knowledge base template for Jekyll. Browse through a [live demo](https://orange-ape.cloudvent.net/).
4+
5+
![Base template screenshot](images/_screenshot.png)
6+
7+
Base was made by [CloudCannon](http://cloudcannon.com/), the Cloud CMS for Jekyll.
8+
Find more templates and themes at [Jekyll Tips](https://learn.cloudcannon.com/jekyll-templates/).
9+
10+
Learn Jekyll with step-by-step tutorials and videos at [CloudCannon Academy](https://learn.cloudcannon.com/).
11+
12+
## Features
13+
14+
* Tutorials organised by category
15+
* Two types of tutorials - text and video
16+
* Ability to have a "tutorial series"
17+
* FAQ section
18+
* Disqus comments
19+
* Sticky sidebar for main headings in tutorials
20+
* Optimised for editing in [CloudCannon](http://cloudcannon.com/)
21+
* RSS/Atom feed
22+
* SEO tags
23+
* Google Analytics
24+
25+
## Setup
26+
27+
1. Add your site and author details in `_config.yml`.
28+
2. Add your Google Analytics, Disqus and MailChimp keys to `_config.yml`.
29+
3. Get a workflow going to see your site's output (with [CloudCannon](https://app.cloudcannon.com/) or Jekyll locally).
30+
31+
## Develop
32+
33+
Base was built with [Jekyll](http://jekyllrb.com/) version 3.4.3, but should support newer versions as well.
34+
35+
Install the dependencies with [Bundler](http://bundler.io/):
36+
37+
~~~bash
38+
$ bundle install
39+
~~~
40+
41+
Run `jekyll` commands through Bundler to ensure you're using the right versions:
42+
43+
~~~bash
44+
$ bundle exec jekyll serve
45+
~~~
46+
47+
## Editing
48+
49+
Base is already optimised for adding, updating and removing tutorials, navigation, footer and FAQ information in CloudCannon.
50+
51+
The sticky sidebar in tutorials in populated by pulling out `<h2>` elements from the content.
52+
53+
### Posts
54+
55+
* Add, update or remove a post in the *Posts* collection.
56+
* The tutorials page is organised by categories.
57+
* Change the defaults when new posts are created in `_posts/_defaults.md`.
58+
59+
### Post Series
60+
To create a new series:
61+
62+
* Add a new document to the `sets` collection.
63+
* Set the `title` and `description`.
64+
65+
To add a tutorial/post to a series:
66+
* 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`.
67+
* Add a `set_order` field to the tutorial front matter and specify a number. This is the tutorials order in the set.
68+
69+
### Navigation
70+
71+
* Exposed as a data file to give clients better access.
72+
* Set in the *Data* / *Navigation* section.
73+
74+
### Footer
75+
76+
* Exposed as a data file to give clients better access.
77+
* Set in the *Data* / *Footer* section.

‎_config.yml

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# ----
2+
# Site
3+
4+
title: Base
5+
url: "https://orange-ape.cloudvent.net/"
6+
baseurl:
7+
google_analytics_key:
8+
disqus_shortname:
9+
newsletter_action:
10+
11+
# Values for the jekyll-seo-tag gem (https://github.com/jekyll/jekyll-seo-tag)
12+
logo: /siteicon.png
13+
description: Knowledge base template for Jekyll.
14+
author:
15+
name:
16+
email:
17+
twitter: # twitter username without the @ symbol
18+
social:
19+
name: Base Template
20+
links:
21+
- https://github.com/CloudCannon/base-jekyll-template
22+
23+
# -----
24+
# Build
25+
26+
permalink: /:categories/:title/
27+
28+
gems:
29+
- jekyll-sitemap
30+
- jekyll-seo-tag
31+
- jekyll-feed
32+
- jekyll-archives
33+
34+
exclude:
35+
- Gemfile
36+
- Gemfile.lock
37+
- README.md
38+
- LICENCE
39+
40+
collections:
41+
sets:
42+
43+
44+
jekyll-archives:
45+
enabled: ['categories']
46+
47+
defaults:
48+
-
49+
scope:
50+
path: ""
51+
values:
52+
layout: "default"
53+
-
54+
scope:
55+
type: "posts"
56+
values:
57+
layout: "post"
58+
comments: true
59+
-
60+
scope:
61+
type: "sets"
62+
values:
63+
_hide_content: true
64+
-
65+
scope:
66+
path: "index.html"
67+
values:
68+
body_class: "show_hero_search"
69+
# -----------
70+
# CloudCannon
71+
72+
social_icons:
73+
- Facebook
74+
- Google Plus
75+
- Instagram
76+
- LinkedIn
77+
- Pinterest
78+
- Tumblr
79+
- Twitter
80+
- YouTube
81+
- Email
82+
- RSS
83+
84+
types:
85+
- Document
86+
- Video
87+
88+
_comments:

‎_data/footer.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
- name:
2+
link: https://facebook.com/
3+
new_window: true
4+
social_icon: Facebook
5+
- name:
6+
link: https://twitter.com/
7+
social_icon: Twitter
8+
new_window: true
9+
- name:
10+
link: https://youtube.com/
11+
social_icon: YouTube
12+
new_window: true
13+
- name:
14+
link: /feed.xml
15+
social_icon: RSS
16+
new_window: false

‎_data/navigation.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
- name: Tutorials
2+
link: /
3+
- name: Videos
4+
link: /videos/
5+
- name: FAQ
6+
link: /faq/

‎_includes/document-icon.html

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{% case include.icon %}
2+
{% when "Video" %}
3+
<svg fill="#000000" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
4+
<path d="M0 0h24v24H0z" fill="none"/>
5+
<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"/>
6+
</svg>
7+
{% when "Document" %}
8+
<svg fill="#000000" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
9+
<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"/>
10+
<path d="M0 0h24v24H0z" fill="none"/>
11+
</svg>
12+
{% endcase %}

‎_includes/footer.html

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<footer>
2+
<div class="wrapper">
3+
<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>
4+
<ul class="footer-links">
5+
{% for link in site.data.footer %}
6+
<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 %}>
7+
{% if link.social_icon %}
8+
{% include social-icon.html icon=link.social_icon %}
9+
{% endif %}
10+
{{ link.name }}</a></li>
11+
{% endfor %}
12+
</ul>
13+
<p class="copyright">&copy; {{ site.title }} {{ site.time | date: "%Y" }}. All rights reserved.</p>
14+
</div>
15+
</footer>

‎_includes/listings.html

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<ul class="listing">
2+
{% for item in include.listings %}
3+
<li {% if item.url == page.url %}class="active"{% endif %}>
4+
<a href="{{ site.baseurl }}{{ item.url }}">
5+
<div class="icon">{% include document-icon.html icon=item.type %}</div>
6+
<article>
7+
<div>
8+
<h3>{% if include.numbered %}{{ forloop.index }}. {% endif %}{{ item.title }}</h3>
9+
<p class="description">{{ item.description }}</p>
10+
</div>
11+
</article>
12+
</a>
13+
</li>
14+
{% endfor %}
15+
</ul>

‎_includes/logo.html

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<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"
2+
width="68.375px" height="24px" viewBox="0 0 68.375 24" enable-background="new 0 0 68.375 24" xml:space="preserve">
3+
<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
4+
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
5+
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
6+
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
7+
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
8+
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
9+
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"/>
10+
<path fill="none" d="M0,0h24v24H0V0z"/>
11+
<g>
12+
<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
13+
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
14+
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
15+
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
16+
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
17+
S31.612,10.08,30.642,10.08z"/>
18+
<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
19+
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
20+
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
21+
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
22+
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
23+
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
24+
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"/>
25+
<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
26+
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
27+
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
28+
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
29+
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
30+
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
31+
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
32+
c1.207,0.439,2.021,0.881,2.445,1.326C54.689,15.117,54.901,15.678,54.901,16.352z"/>
33+
<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
34+
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
35+
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
36+
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
37+
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
38+
C62.707,10.319,62.088,10.061,61.284,10.061z"/>
39+
</g>
40+
</svg>

0 commit comments

Comments
 (0)