https://github.com/cloudcannon/base-jekyll-template

:blue_book: Knowledge base template for Jekyll
https://github.com/cloudcannon/base-jekyll-template

jekyll jekyll-template jekyll-theme

Last synced: 5 days ago
JSON representation

:blue_book: Knowledge base template for Jekyll

• Host: GitHub
• URL: https://github.com/cloudcannon/base-jekyll-template
• Owner: CloudCannon
• License: mit
• Created: 2017-01-27T23:56:46.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2022-12-05T02:43:14.000Z (almost 2 years ago)
• Last Synced: 2024-09-28T02:41:33.191Z (5 days ago)
• Topics: jekyll, jekyll-template, jekyll-theme
• Language: HTML
• Homepage: https://orange-ape.cloudvent.net
• Size: 235 KB
• Stars: 321
• Watchers: 12
• Forks: 200
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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/).

[![Deploy to CloudCannon](https://buttons.cloudcannon.com/deploy.svg)](https://app.cloudcannon.com/register#sites/connect/github/CloudCannon/base-jekyll-template)

## 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 `
` 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 `order_number` 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.