Skip to content

keikai/doc

Repository files navigation

Keikai Document Website

Website: https://keikai.io
Demo: https://keikai.io/demo
Blog: https://keikai.io/blog

Document Folder Structure

  • tutorial: tutorial
  • dev-ref: Developer Reference

Preview at Local

install necessary gem bundle install

start a local web server bundle exec jekyll serve

Ref: Setting up your GitHub Pages site locally with Jekyll

Base Theme: Minimal Mistakes

from: https://jekyllthemes.io/

Font source

Google font

Apply Jekyll Remote Theme

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

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.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published