Koishumi

Koishumi is a blogging platform based Github API.

What's Koishumi?

Quite a few static blogging platforms need building files. But in Koishumi, you don't need to build any file. There is just one thing you should do, that is to push markdown files to your repo, and you'll find your blog is ready.

How to use it?

Fork this repo to your account.
MUST Change settings and titles (in index.html).
Upload your markdown files to the branch that you chose (or whatever).
Enjoy it!

How to change settings?

First, checkout to branch gh-pages. Then, open index.html. And you'll find there is something like this:

<html lang="zh-cmn-Hant">
<head>
...
  <title>Koishumi</title>
...
  <script>
    var config = {
      github: {
        repo: 'Kunr/Koishumi',
        branch: 'markdown',
        path: ''
      },
      comment: {
        type: 'disqus',
        shortname: 'koishumi'
      }
    }
  <script>

Great! All you need is to change Koishumi to {SITE NAME} and Kunr/Koishumi to {{ACCOUNT NAME}}/{{PROJECT NAME}}. Next, just push it to github! All is ready, just enjoy it.

How to set up Comments?

Koishumi supports two kinds of comment hosting service, one is Disqus and the other is DuoShuo. To use it, just change the setting in index.html.

Like this,

var config = {
  ...
  comment: {
    type: 'disqus',
    shortname: 'koishumi'
  }
}

Change koishumi to your site's shortname!

Bugs and feature reporting

Search for existing and closed issues, if it's not addressed yet, open a new issue.

LICENSE

This software is free to use under the Apache 2.0.

cchlorine / Koishumi