Skip to content

JekyllKB - A Knowledge Base framework for jekyll the static site generator in Ruby.

License

Notifications You must be signed in to change notification settings

AJAlabs/jekyllkb

Repository files navigation

JekyllKB v0.1.2

JekyllKB - A Knowledge Base framework for jekyll the static site generator in Ruby.

JekyllKB can be used as a knowledge base framework or starter theme for your Jekyll documentation site.

Version 0.1.2 is just a simple Jekyll starter theme. STAY TUNED!

Installation

  1. Install Jekyll: gem install jekyll

  2. Fork and clone this repo

  3. From your local clone run bundle install

  4. Once bundler is finished you can fire up Jekyll: jekyll serve --watch

That's it! You're now ready to start hacking on your new knowledge base. enjoy!

Usage

  • placeholder

Resources & Dependancies

Introduction to Jekyll-Assets

Requirements

Installing JekyllKB is easy and straight-forward, but there are a few requirements you’ll need to make sure your system has before you start. Git or rsync is recommended but not required.

Directory Structure and Ruby on Rails style asset pipeline

jekyllkb/
├── _assets/
|    ├── fonts/
|    ├── images/
|    ├── javascripts/
|    |   ├── custom/       // Custom javascripts
|    |   ├── bootstrap.js  // Bootstrap compiled javascript
|    |   ├── jekyllkb.js   // JekyllKB javascript that requires all other javascripts
|    |   ├── jquery.js     // jQuery
|    ├── stylesheets/      // Preprocessed Sass styles
├── _includes/
|    ├── custom/           // directory to store your custom includes
|    ├── analytics.html    // Google Analytics
|    ├── footer.html       //site footer
|    ├── header.html       //site head
├── _layouts/
|    ├── custom/           // directory to store your custom layouts
|    ├── home.html         // homepage layout
|    ├── page.html         // page layout
|    ├── post-index.html   // post listing layout
|    └── post.html         // post layout
├── _plugins/
├── about/
|    ├── index.html        // Default About Page
├── contact/
|    ├── index.html        // Default Contact Page
├── blog/
|    ├── _posts/           // Blog posts directory
|    ├── index.html        // Blog index file
├── kb/
|    ├── _posts/           // Knowledge Base articles directory
|    ├── index.html        // Knowledge Base index file
└── index.html             // Homepage

Customizing

  • placeholder

Bugs and Feature Requests

Have a bug or a feature request? Please open a new issue. Before opening an issue, please search for existing issues in this repo as well as the mojombo/jekyll repository.

Versioning

JekyllKB is maintained under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

  • Breaking backward compatibility bumps the major (and resets the minor and patch)
  • New additions without breaking backward compatibility bumps the minor (and resets the patch)
  • Bug fixes and misc changes bumps the patch

For more information on SemVer, please visit http://semver.org/.

Support, Troubleshooting and Discussions

If you're having any problems with JekyllKB, here are a few resources for finding answeres:

License

See the LICENSE file for licensing and copyright details.

Authors

AJ Acevedo

Mike Barnard

About

JekyllKB - A Knowledge Base framework for jekyll the static site generator in Ruby.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages