Jekyll Booklet

Jekyll Booklet is an easy way to publish beautiful, single-paged, simple-indexed HTML Books through Jekyll , "a simple, blog aware, static site generator". This beautiful theme used to make markdown files appear like pages in a book, is a merge of two awesome layouts, FullScreenBookBlock and MultiLevelPushMenu. Only the merge and some modifications were done by me, the major part of theme is work of Mary Lou at codrops. You can fork this project here.

You can flip pages of this booklet, using arrow keys on keyboard, arrow buttons on top-left of page and touch gestures.

Naming Conventions

Naming conventions are same as the ones followed by Jekyll. You can check them here. Jekyll Booklet displays posts in ascending order in the index, posts written earlier will be always above the posts written later. YAML front-matter block in your markdown should only contain two things 'title' and 'tags'. 'title' will be converted to page-title and 'tags' will be converted into unit names that will be used to categorize articles into Units in Hierchical Index mode. Ideally an article should have a single tag, as a chapter in a book cannot be present in more than one Unit.

Taking this page as example, the page name in _posts directory is '2014-3-2-Naming-Conventions.markdown' and the YAML front matter is

      ---
      title: "Naming Conventions"
      tags: How_it_Works_?
      ---

The '_' in tag will be replaced by ' '(space) in index.

Index Types

There are two types of index available, Simple and Hierarchical . You cannot use both type at the same time, atleast not right now. If you intend to use the 'Simple' style you should not include tags in ANY of your article's YAML front-matter. Likewise, if you intend to use 'Hierarchical' style, you should include one and only one tag in EVERY article's YAML front-matter. 'tags' will be used to classify posts unit-wise. Posts having same tag will fall under same unit inside the index.

Youtube Videos

If you want to link a youtube video in your posts, use the youtube tag like this :

{% youtube VpZmIiIXuZ0 %}

And the video will be displayed like this

Code Highlighting

Jekyll booklet uses Highlight.js to highlight code. 'Foundation' theme is the default and the only included theme. To use code highlighting place code inside highlight tags like this :

  {% highlight text %} 
      #include <stdio.h>
      int main()
      {
          printf("Hello World\n");
      }
  {% endhighlight %}

And the code will be highlighted like this :

 
        #include <stdio.h>
        int main()
        {
            printf("Hello World\n");
        }

Licenses

This project makes use of Jekyll and layouts from Codrops. So here are their Licensing policies and Terms of Use Jekyll and Codrops.

If you like this project or find it useful in some way or other, let me know @ChintanGhate. This project is not yet perfect, as I am not that well versed in JS or CSS, so if you would like to improve it, fork it on github and send pull requests to make it better.

Thank You.