/LiuUncle.github.io

pmyangliu personal website

Primary LanguageCSSMIT LicenseMIT

Kiko Plus Theme

image

You can see live demo here

This theme is inspired by Kiko theme, powered by Jekyll, hosted on Github Pages.

Features

  • Disqus comment system
  • Google analytics
  • Pagination support
  • Custom tags
  • SEO support

Installation

Method 1: new master's repository (The Best)

  1. First fork it.
  2. Change your forked repository name Kiko-plus to USERNAME.github.io where USERNAME is your github user name.
  3. Access your new blog via https://username.github.io.
  4. See configuration.

Method 2: gh-pages in existing repository

  1. Create a new branch called gh-pages in the repository where you want to add a template managing branches.
  2. From command line run git clone https://github.com/AWEEKJ/Kiko-plus.git - this will clone Kiko-plus template to your computer.
  3. Create new branch git checkout -b gh-pages where gh-pages will be your branch name.
  4. Add remote, which is your repo from the first step, to your new branch git remote add gh-pages https://github.com/<yourName>/<yourMaster>/gh-pages. yourName is your account name and yourMaster is your repository.
  5. Push new branch to remote git push gh-pages.
  6. Update _config.yml file by changing baseurl: "<branchName>" branchName is your branch name where gh-pages resides. See configuration.

Method 3: run it locally

  1. Download zip or clone it git clone https://github.com/AWEEKJ/Kiko-plus.
  2. Go inside folder and run jekyll serve or bundle exec jekyll s or rake preview. This will build a website which you can access https://localhost:4000. You need to have Jekyll installed to do this.

Configuration

All configuration is done via _config.yml file which you will find in your main repo folder. Change this <something> to yours.

  • Change this to your blog name.
name: <blog-name>
  • Change this to your domain. NOTE- if running locally change this to url: "https://localhost:4000".
url: "https://<your-name>.github.io"
  • Change this to your branch name where gh-pages resides. !NOTE apply only if you used Method 2 for installation.
baseurl: "/<branch-name>"
  • These configuration in author: is for links to icons in footer. Modify _includes/footer.html to add more link icons.
author:
  name:             your-name
  facebook:         your-id
  twitter:          your-id
  github:           your-id
  linkedin:         your-id
  medium:           your-id
  tumblr:           your-id
  email:            your-id@your-email.com
  • Change this to your Google Analytic ID.
google-analytics:
  id:               your-id
  • Change this to your Disqus ID.
disqus:
  id:               your-id

Rakefile Usage

$ rake post title="A Title" [date="2015-08-16"] [tags=[tag1,tag2]]
$ rake draft title="A Title" [date="2015-08-16"] [tags=[tag1,tag2]]
$ rake preview

License

This theme is released under MIT License.