Skip to content
This repository has been archived by the owner on Nov 11, 2017. It is now read-only.

Latest commit

 

History

History
132 lines (90 loc) · 3.8 KB

README.md

File metadata and controls

132 lines (90 loc) · 3.8 KB
Raw

NOTE! Kiko-plus theme will not be update anymore. Please see the new and easier version, kiko-now theme which is mixed jekyll-now and Kiko-plus.

Kiko Plus Theme

image

You can see live demo here. This theme is inspired by Kiko theme.

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 username.
  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.

Configuration

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

Basic

  • Config your blog name.
name: <blog-name>
  • These configuration in author: is for links to icons in footer. If you want to add more link icons, modify _includes/footer.html file.
author:
  facebook:         your-id
  twitter:          your-id
  github:           your-id
  linkedin:         your-id
  medium:           your-id
  tumblr:           your-id
  email:            [email protected]
  • Change copyright year and name in footer.
copyright:
  year:             2017
  name:             Kiko

Google analytics

  • Change this to your Google Analytic ID.
google-analytics:
  id:               "your-id"

Disqus

  • Change this to your Disqus short name.
disqus:
  id:               "your-id"

URL

  • Config your domain.
url: "https://<your-name>.github.io"
  • NOTE When if running locally, change url to
url: "https://localhost:4000"
  • Change this to your branch name where gh-pages resides.
  • NOTE apply only if you used Method 2 for installation.
baseurl: "/<branch-name>"

Run in Local

  1. Download or clone your remote repository.
  2. Go inside folder. First, run rake geminstall.
  3. Second, run jekyll serve or rake preview. This will build a website which you can access https://localhost:4000. Make sure that url in _config.yml file is url: "https://localhost:4000". You need to have Jekyll installed to do this.

Rakefile Usage

# Create new post
$ rake post title="A Title" [date="2015-08-16"] [tags="[tag1, tag2]"] 

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

# Install Jekyll Plugins. Do before running in local.
$ rake geminstall

# Run in Local
$ rake preview

License

This theme is released under MIT License.