crispgm / wiki-theme

Wiki theme for Jekyll

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Crisp Wiki Theme for Jekyll

A simple responsive wiki theme for Jekyll from Crisp.

I use it on my website https://crispgm.com/wiki/.

Installation

Manual

  1. Clone the project.

    git clone https://github.com/crispgm/wiki.git
    
  2. Modify _data/wiki.yml to add your QAs.

    - q: What is Jekyll?
      a: It is a static site generator.
  3. Run, debug & build with jekyll.

    # Run
    jekyll serve
    # Build
    jekyll build
    

Gem-based theme

  1. To install a theme, first, add the theme to your site's Gemfile:

    gem 'jekyll-theme-crisp-wiki'
    
  2. Save the changes to your Gemfile

  3. Run the command bundle install to install the theme

  4. Finally, activate the theme by adding the following to your site's _config.yml:

    theme: jekyll-theme-crisp-wiki
    

For more information, please read https://jekyllrb.com/docs/themes/.

Configuration

  • title
  • author
  • highlight

Sample

[Sample Site][Screenshot]

About

Wiki theme for Jekyll

License:MIT License


Languages

Language:CSS 46.3%Language:HTML 35.1%Language:Ruby 18.5%