Skip to content

Latest commit

 

History

History
114 lines (82 loc) · 3.19 KB

README.md

File metadata and controls

114 lines (82 loc) · 3.19 KB
Raw

ZK Document Website

Sidebar

support 3 levels of hierarchy. See nav_list.

Document Folder Structure

  • each book has its own folder

highlight the current page in the sidebar

make page.url equal to child.url with permalik:

permalink: /get_started/Learn_ZK_in_10_Minutes

Because page.url ends with .html by default.

Preview at Local

  • install necessary gem for one time bundle install
  • each time just start a local web server preview.sh

Ref: Setting up your GitHub Pages site locally with Jekyll

Base Theme: Minimal Mistakes

from: https://jekyllthemes.io/

Apply Jekyll Remote Theme

Jekyll plugin for building Jekyll sites with any public GitHub-hosted theme

Apply Local theme

in Gemfile gem "minimal-mistakes-jekyll", path: "/Users/hawk/Documents/workspace/KEIKAI-SPACE/minimal-mistakes/"

Usage

  1. Add the following to your Gemfile
gem "jekyll-remote-theme"

and run bundle install to install the plugin

  1. Add the following to your site's _config.yml to activate the plugin
plugins:
  - jekyll-remote-theme

Note: If you are using a Jekyll version less than 3.5.0, use the gems key instead of plugins.

  1. Add the following to your site's _config.yml to choose your theme
remote_theme: benbalter/retlab

Declaring your theme

Remote themes are specified by the remote_theme key in the site's config.

Remote themes must be in the form of OWNER/REPOSITORY, and must represent a public GitHub-hosted Jekyll theme. See the Jekyll documentation for more information on authoring a theme. Note that you do not need to upload the gem to RubyGems or include a .gemspec file.

You may also optionally specify a branch, tag, or commit to use by appending an @ and the Git ref (e.g., benbalter/[email protected] or benbalter/retlab@develop). If you don't specify a Git ref, the master branch will be used.

Book alphebetical order

  1. Getting Started
  2. ZATS Essentials
  3. ZK Calendar Essentials
  4. ZK Charts Essentials
  5. ZK Client-side Reference
  6. ZK Component Development Essentials
  7. ZK Component Reference
  8. ZK Configuration Reference
  9. ZK Developer's Reference
  10. ZK Essentials
  11. ZK Installation Guide
  12. ZK JSP Tags Essentials
  13. ZK MVVM Reference
  14. ZK Pivottable Essentials
  15. ZK Spring Essentials
  16. ZK Studio Essentials
  17. ZK Style Customization Guide
  18. ZUML Reference

published order

  1. ZK JSP Tags Essentials
  2. ZATS Essentials
  3. ZK PivotTable Essentials
  4. ZK Studio Essentials
  5. ZK Spring Essentials
  6. ZK Component Development Essentials
  7. ZK Calendar Essentials

Editor Guidelines

Sections to remove

  • "Version History" section. Using # Version History(.|\n)* to find and remove it.
  • __TOC__
  • replace versionsince with version-badge.html version=

prepend the image path.

  • replace !\[\]\(([^)]*)\) with ![](images/$1)
  • replace <img src="([^"]*)" with <img src="images/$1

check page link

  • \[([^\]]+)\]\((https?:\/\/[^\)]+)\)