Jekyll GitBook

Make Jelly site have a GitBook look!

Demo

Live demo on Github Pages: https://sighingnow.github.io/jekyll-gitbook

Why Jekyll with GitBook

GitBook is an amazing frontend style to present and organize contents (such as book chapters
and blogs) on Web. The typical to deploy GitBook at Github Pages
is building HTML files locally and then push to Github repository, usually to the gh-pages
branch. It's quite annoying to repeat such workload and make it hard for people do version
control via git for when there are generated HTML files to be staged in and out.

This theme takes style definition out of generated GitBook site and provided the template
for Jekyll to rendering markdown documents to HTML, thus the whole site can be deployed
to Github Pages without generating and uploading HTML bundle every time when there are
changes to the original repo.

How to Get Started

This theme can be used just as other Jekyll themes.

Fork this repository and add your markdown posts to the _posts folder.

Deploy Locally with Jekyll Serve

This theme can be ran locally using Ruby and Gemfiles.

Testing your GitHub Pages site locally with Jekyll - GitHub

Full-text search

The jekyll-gitbook theme support a "Search" page that enables visitors to search contents
from the whole site. The search functionality is powered by jekyll-tipue-search can you
can try it from:

https://sighingnow.github.io/jekyll-gitbook/search/?q=generated

How to generate TOC

The jekyll-gitbook theme leverages jekyll-toc to generate the Contents for the page.
The TOC feature is not enabled by default. To use the TOC feature, modify the TOC
configuration in _config.yml:

toc:
    enabled: true

License

This work is open sourced under the Apache License, Version 2.0.

Copyright 2019 Tao He.