adelorenzo/jekyll-gitbook
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Links for fork.

Browse Source 
Signed-off-by: HE, Tao <sighingnow@gmail.com>
This commit is contained in:
HE, Tao 2019-04-28 19:49:18 +08:00
parent 915ac3b2ed
commit 639825e67f
No known key found for this signature in database
GPG Key ID: E1C05D3ACA574FD9
3 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -9,21 +9,21 @@ Make Jelly site have a GitBook look!
## Why Jekyll with GitBook ## Why Jekyll with GitBook
GitBook is an amazing frontend style to present and organize contents (such as book chapters 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](https://pages.github.com/) and blogs) on Web. The typical to deploy GitBook at [Github Pages][1]
is building HTML files locally and then push to Github repository, usually to the `gh-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 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. 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 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 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 to [Github Pages][1] without generating and uploading HTML bundle every time when there are
changes to the original repo. changes to the original repo.
## How to Get Started ## How to Get Started
This theme can be used just as other [Jekyll themes][1]. This theme can be used just as other [Jekyll themes][1].
Fork this repository and add your markdown posts to the `_posts` folder. [Fork][3] this repository and add your markdown posts to the `_posts` folder.
## License ## License
@ -31,5 +31,6 @@ This work is open sourced under the Apache License, Version 2.0.
Copyright 2019 Tao He. Copyright 2019 Tao He.
[2]: https://pages.github.com [1]: https://pages.github.com
[2]: https://pages.github.com/themes [2]: https://pages.github.com/themes
[3]: https://github.com/sighingnow/jekyll-gitbook/fork

2
_includes/toc-date.html
View File

@ -33,7 +33,7 @@
<li class="divider"></li> <li class="divider"></li>
<li> <li>
<a href="https://github.com/sighingnow/jekyll-gitbook" target="blank" class="gitbook-link"> <a href="https://github.com/sighingnow/jekyll-gitbook/fork" target="blank" class="gitbook-link">
Fork it Now! Fork it Now!
</a> </a>
</li> </li>

3
_posts/2019-04-28-howto.md
View File

@ -8,7 +8,8 @@ layout: post
This theme can be used just as other [Jekyll themes][1]. This theme can be used just as other [Jekyll themes][1].
Fork this repository and add your markdown posts to the `_posts` folder, then [Fork][2] this repository and add your markdown posts to the `_posts` folder, then
push to your own Github repository. No need to push generated HTML bundle. push to your own Github repository. No need to push generated HTML bundle.
[1]: https://pages.github.com/themes [1]: https://pages.github.com/themes
[2]: https://github.com/sighingnow/jekyll-gitbook/fork