Base Jekyll Template

Theme by Cloudcannon

|

Updated: 5 Dec 2022

|

330 Stars

:blue_book: Knowledge base template for Jekyll

Overview

The BaseKnowledge base template for Jekyll is a user-friendly and customizable theme designed by CloudCannon. It is designed to create a knowledge base or documentation website with ease. This template offers various features and capabilities that make it ideal for organizing and presenting tutorials, FAQs, and other information.

Features

• Tutorials organized by category, allowing for easy navigation and browsing.
• Support for both text and video tutorials, providing flexibility in content creation.
• Ability to create a “tutorial series,” enabling users to group related tutorials together.
• FAQ section to address common questions and provide quick answers.
• Integration with Disqus comments, allowing users to engage with the content and ask questions.
• Sticky sidebar for main headings in tutorials, making it easy for users to navigate within a tutorial.
• Optimized for editing in CloudCannon, a Cloud CMS for Jekyll, providing a seamless editing experience.
• RSS/Atom feed support for easy syndication of content.
• Built-in support for SEO tags, ensuring better visibility in search engine results.
• Integration with Google Analytics for detailed website analytics and tracking.

Installation

To install the BaseKnowledge base template, follow these steps:

1. Add your site and author details in the _config.yml file.
2. Add your Google Analytics, Disqus, and MailChimp keys to the _config.yml file.
3. Set up a workflow to see your site’s output either with CloudCannon or Jekyll locally.
4. Install the dependencies with Bundler by running the following command:

   bundle install
   

5. Run Jekyll commands through Bundler to ensure you’re using the correct versions. For example, instead of running jekyll serve, run the following command:

   bundle exec jekyll serve
   

Summary

The BaseKnowledge base template for Jekyll is a powerful tool for creating knowledge bases and documentation websites. With its user-friendly features and easy installation process, users can quickly organize and present tutorials, FAQs, and other information. The template also provides integration with popular tools like Disqus and Google Analytics, allowing for increased user engagement and better insights into website performance. Whether you’re a developer, writer, or content creator, the BaseKnowledge base template is a valuable resource for creating a professional and informative website.