From 0f29ba707aa38e714ca6b9858b7709ec0f710b7f Mon Sep 17 00:00:00 2001 From: OnkelDe <84448649+OnkelDe@users.noreply.github.com> Date: Mon, 17 Jun 2024 13:05:13 +0200 Subject: [PATCH] back --- docs/_posts/2019-04-27-why.md | 20 ++++++++++++++++ docs/_posts/2019-04-28-howto.md | 38 +++++++++++++++++++++++++++++++ docs/_posts/2019-04-29-license.md | 12 ++++++++++ 3 files changed, 70 insertions(+) create mode 100644 docs/_posts/2019-04-27-why.md create mode 100644 docs/_posts/2019-04-28-howto.md create mode 100644 docs/_posts/2019-04-29-license.md diff --git a/docs/_posts/2019-04-27-why.md b/docs/_posts/2019-04-27-why.md new file mode 100644 index 0000000..81af6b7 --- /dev/null +++ b/docs/_posts/2019-04-27-why.md @@ -0,0 +1,20 @@ +--- +title: Why Jekyll with GitBook +author: Tao He +date: 2019-04-27 +category: Jekyll +layout: post +--- + +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][1] +is building HTML files locally and then push to Github repository, usually to the `gh-pages` +branch. However, 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][1] without generating and uploading HTML bundle every time when there are +changes to the original repository. + +[1]: https://pages.github.com \ No newline at end of file diff --git a/docs/_posts/2019-04-28-howto.md b/docs/_posts/2019-04-28-howto.md new file mode 100644 index 0000000..d1e9750 --- /dev/null +++ b/docs/_posts/2019-04-28-howto.md @@ -0,0 +1,38 @@ +--- +title: How to Get Started +author: Tao He +date: 2019-04-28 +category: Jekyll +layout: post +--- + +The jekyll-gitbook theme can be used just as other [Jekyll themes][3] and +support [remote theme][2] on [Github Pages][1], see [the official guide][4] +as well. + +You can introduce this jekyll theme into your own site by either + +- [Fork][5] this repository and add your markdown posts to the `_posts` folder, then + push to your own Github repository. +- Use as a remote theme in your [`_config.yml`][6](just like what we do for this + site itself), + +```yaml +# Configurations +title: Jekyll Gitbook +longtitle: Jekyll Gitbook + +remote_theme: sighingnow/jekyll-gitbook +``` + +> ##### TIP +> +> No need to push generated HTML bundle. +{: .block-tip } + +[1]: https://pages.github.com +[2]: https://github.com/sighingnow/jekyll-gitbook/fork +[3]: https://pages.github.com/themes +[4]: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll +[5]: https://github.com/sighingnow/jekyll-gitbook/fork +[6]: https://github.com/sighingnow/jekyll-gitbook/blob/master/_config.yml diff --git a/docs/_posts/2019-04-29-license.md b/docs/_posts/2019-04-29-license.md new file mode 100644 index 0000000..793e52a --- /dev/null +++ b/docs/_posts/2019-04-29-license.md @@ -0,0 +1,12 @@ +--- +title: License +author: Tao He +date: 2019-04-29 +category: Jekyll +layout: post +--- + +This work is open sourced under the Apache License, Version 2.0, using the +same license as the original [GitBook](https://github.com/GitbookIO/gitbook) repository. + +Copyright 2019 Tao He.