An open API service indexing awesome lists of open source software.

https://github.com/jeiwan/one-step-scala

Learning Scala step-by-step
https://github.com/jeiwan/one-step-scala

Last synced: 3 months ago
JSON representation

Learning Scala step-by-step

Awesome Lists containing this project

README

        

# Kiko Plus Theme

![image](/images/image.png)

You can see live demo [here](https://aweekj.github.io/Kiko-plus). This theme is inspired by [Kiko](http://github.com/gfjaru/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](https://github.com/AWEEKJ/Kiko-plus/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](https://username.github.io).
4. [See configuration](#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](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/).
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///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_ is your branch name where _gh-pages_ resides. See [configuration](#configuration).

## Configuration

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

### Basic

- Config your blog name.

```yml
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.

```yml
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.

```yml
copyright:
year: 2017
name: Kiko
```

### Google analytics

- Change this to your Google Analytic ID.

```yml
google-analytics:
id: "your-id"
```

### Disqus

- Change this to your Disqus short name.

```yml
disqus:
id: "your-id"
```

### URL

- Config your domain.

```yml
url: "https://.github.io"
```

- **NOTE** When if running locally, change url to

```yml
url: "https://localhost:4000"
```

- Change this to your branch name where _gh-pages_ resides.
- **NOTE** apply only if you used __Method 2__ for installation.

```yml
baseurl: "/"
```

## 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](https://localhost:4000). Make sure that `url` in `_config.yml` file is `url: "https://localhost:4000"`. You need to have [Jekyll](https://jekyllrb.com/docs/installation/) installed to do this.

## Rakefile Usage

```bash
# 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.