Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
antoniocastanheira committed May 5, 2017
0 parents commit 8626ae1
Show file tree
Hide file tree
Showing 57 changed files with 2,234 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
_site/
.sass-cache/
.jekyll-metadata
11 changes: 11 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -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
68 changes: 68 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -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
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
77 changes: 77 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
88 changes: 88 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# ----
# Site

title: ZUP
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: /logo-light.png
description: Knowledge base template for Jekyll.
author:
name:
email:
twitter: # twitter username without the @ symbol
social:
name: ZUP
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:
16 changes: 16 additions & 0 deletions _data/footer.yml
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
- name: Base de conhecimento
link: /
- name: Videos
link: /videos/
- name: Enviar Solicitação
link: /contact/
12 changes: 12 additions & 0 deletions _includes/document-icon.html
Original file line number Diff line number Diff line change
@@ -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 %}
15 changes: 15 additions & 0 deletions _includes/footer.html
Original file line number Diff line number Diff line change
@@ -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>
15 changes: 15 additions & 0 deletions _includes/listings.html
Original file line number Diff line number Diff line change
@@ -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>
7 changes: 7 additions & 0 deletions _includes/logo.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<svg width="86" height="37" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- Created with SVG-edit - http://svg-edit.googlecode.com/ -->
<g>
<title>Layer 1</title>
<image xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFYAAAAlCAYAAADY4B6YAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAIGNIUk0AAG11AABzoAAA/N0AAINkAABw6AAA7GgAADA+AAAQkOTsmeoAAAR4SURBVHja7JpZaFx1FMZ/M07STtqkVm3jUrWBvplShYIFFXxoBaFCEaWIUVJF+6BC65NLVdAXQRSkPojauhANxRarLbbWBzERQStVobWgXcCliw0mxGxNmnw+5IzejDP3njuLTZz7wWVm7pxz7n++/3bO95+UpIuANiBN5ZAC9gGHgEbgXqAuwv6Q+RTCbKAdyAIKifETsDvv/iqgtYhfCugB3gUm7N4lwG3AzcByoNnszgJHgC6gG/gklAFJraoO1ktC0mKnfafZF7ouljTmiLG3gG9nhM/PktJm+4CkY872dktaU6zNaeupMSqPUXudAAYd9sNh/Q/0O2IMxYwL0GevLwGvAS3O33cj8AHwqs2kKUiTYBx4EdhYov96YAfQkBA7Fa3AhjJj3GojdwqxKeCCKjS4boYQm6lQnHuAdUFiJ4AR4JyttWHXYGD3DMMJ4IsaHP1PA/NzvXXU0opUhNNZYCWwOWIJGbXU6IcaJHYxcDuwJWNEHHY4XQk85pjiDwGfzmBy3gE+As4Ac4GlwCPAFU7/duAt7/oyH9hlPRKGZ4E3ZiihQ0bK+3n3PwY6gG3ADY44K4AWT1ZQb5XJsgi7DuCZGTxSNxYgNYffbHP63bkZLvEQu9nSiTB0Aw/O8PXx64jvjwM7nbGWRRH7lIOwI8BaR4Uz3VHvsPnGu4mFEdtma2YYeoA7gZM1suufdtplixF7k9XNUVpAG/Dd/6i0jcJlXp2kELFLbAfMRjg/TJR0Vjmco7hcGITKeMblDpvlzlgn84ldAGx39MzzwOsVJm9uyHfNTGqyUSinNH8yYp29FFjtjHUwSOws4D1HWrUNeKIKo3IFMK/A/UZgCzDHEaOljOdfbxlQMbxs5HrwY1Cc3eoQd7skzQ4RpAtdV0kacIrHHZIWSaqXtEDSKkkHYojr45J2S1orqS7G7wriQ0nXSWqQlJW0VNKOGP6/SGrK/fhNDoeDkppjkoqkhZL6YjSsT9JhST1lnF6M2KlDKcTmOuiYpKPOk4sgXpBEBrgbeM4xvBusMpnlsE0B+0036AV+LTLNC2FeDNtiGCxzI0uXuKyMWpVKBtjkdGqJ+bCxwOvnwDU1kOd25tLPdJk9G4aRwPtKpWVj05jU05ZZUG1ig9gXoxwM0yMer1L7hoFvy8yz202s+ZvY/wIjVlAMlej/GbDG1q+BKukEG4A9JfgOWAW6N3+RnlMlMhvyPn8F3BHsVQdOWM58C/AHcMo5ahuIPhHJLyz6mFT/34w5i1Zabv8v7XAncHWFl4Q08H2B+3uYFIvvB+4CFgUqKtmu2gt8aSNgl5EZxCsm+jwKXBvoQDF5fPQncMDex0HWZtZ9wNum2K0GFgYyoXGL32XF1PZiGkNKEucJWSO2yUbMqKVJZ/jnTxSeTOVCm8ojNi17bXTnsJXA6WlE5ZWvyTZZtdVobRy29p2KCpbh/GGYyf9alYPjVW5jP75/4BScsgmqgITYhNiE2AQJsQmxCbHTEN7jmlQlH5qpAWL78wqGYqiocvbXAATkiDiuHwSsAAAAAElFTkSuQmCC" id="svg_1" height="37" width="86" y="4" x="5"/>
</g>
</svg>
12 changes: 12 additions & 0 deletions _includes/navigation.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<a class="nav-toggle" id="open-nav" href="#">&#9776;</a>
<nav>
<a class="editor-link btn" href="cloudcannon:collections/_data/navigation.yml" class="btn" style="padding: 5px;"><strong>&#9998;</strong> Edit navigation</a>
{% for link in site.data.navigation %}
{% assign class = "" %}

{% if link.link == page.url %}
{% assign class = class | append: " active" %}
{% endif %}
<a href="{% include relative-src.html src=link.link %}" class="{{ class }}">{{ link.name }}</a>
{% endfor %}
</nav>
1 change: 1 addition & 0 deletions _includes/relative-src.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% assign prefix = include.src | slice: 0, 2 %}{% assign protocol = include.src | slice: 0, 4 %}{% unless protocol == 'http' or prefix == "//" %}{{ site.baseurl }}{% endunless %}{{ include.src }}
4 changes: 4 additions & 0 deletions _includes/search-icon.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<svg fill="#000000" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
<path d="M15.5 14h-.79l-.28-.27C15.41 12.59 16 11.11 16 9.5 16 5.91 13.09 3 9.5 3S3 5.91 3 9.5 5.91 16 9.5 16c1.61 0 3.09-.59 4.23-1.57l.27.28v.79l5 4.99L20.49 19l-4.99-5zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"/>
<path d="M0 0h24v24H0z" fill="none"/>
</svg>
5 changes: 5 additions & 0 deletions _includes/search.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<form action="{{ site.baseurl }}/search/" method="get">
<input type="search" name="q" {% if include.add_id %}id="search-input"{% endif %} placeholder="O que você gostaria de saber?" autofocus>
{% include search-icon.html %}
<input type="submit" value="Search" style="display: none;">
</form>
Loading

0 comments on commit 8626ae1

Please sign in to comment.