Go to file

Tao He 72e5cfc2ff Add jekyll-themes.com badge.		2021-02-03 13:28:13 +08:00
_includes	Remove the search bar that doesn't work actually.	2021-01-24 02:32:27 +08:00
_layouts	Fix site URL and base URL.	2019-04-28 19:36:53 +08:00
_posts	Links for fork.	2019-04-28 19:49:18 +08:00
gitbook	Add static resources from gitbook.	2019-04-28 16:37:41 +08:00
_config.yml	Fix site URL and base URL.	2019-04-28 19:36:53 +08:00
.gitignore	Remove the search bar that doesn't work actually.	2021-01-24 02:32:27 +08:00
404.html	Templates for homepage and markdown posts.	2019-04-28 19:16:39 +08:00
index.md	Templates for homepage and markdown posts.	2019-04-28 19:16:39 +08:00
LICENSE	Add full license text.	2019-04-28 19:41:57 +08:00
README.md	Add jekyll-themes.com badge.	2021-02-03 13:28:13 +08:00

README.md

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.

License

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