pombredanne / keyvidev.github.io

Various bits and pieces of information about keyvi - the key value store optimized for size and lookup speed - including internals, use cases, thougths.

Chirpy Starter

The startup template for Jekyll Theme Chirpy.

When installing the Chirpy theme through RubyGems, Jekyll can only read files in the folders _includes, _layout, _sass and assets, as well as a small part of options of the _config.yml file from the theme's gem. (You can find the gem files by using the command bundle info --path jekyll-theme-chirpy). To fully use all the features of Chirpy, you need to copy the other critical files/directories from the theme's gem to your Jekyll site.

The critical files/directories to run or build the Chirpy theme are as follows:

.
├── _data
├── _plugins
├── _tabs
├── _config.yml
└──  index.html

So we've extracted all the Chirpy gem necessary content here to help you get started quickly.

Installation

Use this template to generate a new repository, and then execute:

$ bundle

Usage

Please see the theme's docs.

Upgrading

First, please modify the target version number of jekyll-theme-chirpy in the Gemfile (e.g., gem "jekyll-theme-chirpy", "~> 4.0", ">= 4.0.1").

After that, execute the following command:

$ bundle update jekyll-theme-chirpy

As the version upgrades, the critical files and configuration options will change. Please refer to the Upgrade Guide to keep your website files in sync with the latest version of the theme.

License

This work is published under MIT License.