cloudcannon / base-jekyll-template

:blue_book: Knowledge base template for Jekyll

Base

Knowledge base template for Jekyll. Browse through a live demo.

Base was made by CloudCannon, the Cloud CMS for Jekyll.

Find more templates, themes and step-by-step Jekyll tutorials at CloudCannon Academy.

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
• 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 or Jekyll locally).

Develop

Base was built with Jekyll version 3.4.3, but should support newer versions as well.

Install the dependencies with Bundler:

$ bundle install

Run jekyll commands through Bundler to ensure you're using the right versions:

$ 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 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.

base-jekyll-template's Issues

Categories page doesn't work

Hello,

Im trying to use this template for my blog but i can't get the blog pages to work.

https://dataengineers.me/category/account-settings/

Regards,

Sticky Sidebar Navigation is not working on GitHub Pages

I have hosted Jekyll site using bese-jekyll-template on github pages. But the sticky sidebar navigation is not working. Any Idea to resolve this? Is there any way to use custom plugins for github pages ?

File not found when click category link

Dear you !

I fork jekyll them https://github.com/vietevo/vietevo.github.io and config url: "https://vietevo.github.io/" value in __config.yml.

Then i access link https://vietevo.github.io/, it is ok. But, when click link https://vietevo.github.io/category/billing/`, result http://prntscr.com/emzjxu.

I try https://orange-ape.cloudvent.net/category/account-settings/. It is ok.

Can you guide for me and fix.

Thanks

Unmodified installation does not show headers navigation sidebar in posts

Is there something additional that needs to be uncommented somewhere? It looks great on the live demo, but doesn't appear when I install it without making any changes.

...or is it something external like a plugin?

How to install as a theme?

Is it possible to install this template as a theme? I really like the structure of this theme and the license works for me. I tried searching rubygems.org and can't find a project called base-jekyll-template. And I like the cloudcannon docs on how to use jekyll, but couldn't find how to use this particular theme.

Before I fork and dump in my own content, I wanted to check with y'all to see if I'm missing something that might be an easier way to use your template.

Sticky Sidebar Navigation is not working.

I forked this repo, but when I visit post page the sidebar navigation doesn't shows anything. It return empty result.

<section class="sidebar sticky">
    <ul>
        {% assign sub_navigation = content | extract_element: 'h2' %}
        {% for item in sub_navigation %}
            <li><a href="#{{ item.id }}">{{ item.text }}</a></li>
        {% endfor %}
    </ul>
</section>

But it works well on your demo site.

Your theme is listed in jekyll-themes.com

Your theme has been listed on https://jekyll-themes.com/.

Liquid Error

When trying to serve up a fork of this site I'm getting the following:

Configuration file: /home/bdub/kb/base-jekyll-template/_config.yml
Configuration file: /home/bdub/kb/base-jekyll-template/_config.yml
            Source: /home/bdub/kb/base-jekyll-template
       Destination: /home/bdub/kb/base-jekyll-template/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
  Liquid Exception: Liquid syntax error (line 7): Unknown tag 'when' in vendor/bundle/gems/liquid-3.0.6/lib/liquid/locales/en.yml
jekyll 3.4.3 | Error:  Liquid syntax error (line 7): Unknown tag 'when'

Any idea what might be causing this?