Project Gaia - Read Me

1. Usage

1. Fork and give me a star!
2. Important: Please change the baseurl value in _config.yml to [your repo name]

2. Whats New in Version 2.0?

1. New Layout for sidebar
2. New Category page
3. New Code Highlighter
4. Latest Bootstrap
5. Animation
6. SCSS + ES6

3. Blog Plugins

3.1. Stickie Post

Put a attribute stickie: true in YAML header for specific post:

layout: post
title: blablablalala
category : Comic
tags : [Comic, 10101]
stickie: true 

Then current post will show ahead of other posts.

3.2. Comments Plugin

Change the content in _includes/comment-full.html, then all post pages will have a comment plugin.

4. Post Plugins

You could active/deactive all plugins in js/post.js

    let config = {
      activeHighlight: true,
      activeHeaderCollapse: true,
      activeHeaderNumber: true,
      activeLightbox: true,
      activeReadingProgressBar: true,
    }

4.1. Highlighter

Write your code like this:

```
  var szhshp = 'cool';
```

Plugin will auto detect your language and highlight it.

If you want to set the language manually:

```js
  var szhshp = 'cool';
```

And the code snippet will be highlighted as below:

  var szhshp = 'cool';
  var szhshp = 'awesome';

4.2. headerNumber

Add episode numbers for main headers

4.3. md-post-header-collapse

Realized with this repo: szhielelp/md-post-header-collapse

Run $.headerCollapseRobot() after post loaded.

    $.headerCollapseRobot('#page-content', ['h1', 'h2', 'h3'], ['blockquote']);

You can try clicking on the icons near titles.

4.4. Reading Progressbar

Inspired from http://es6.ruanyifeng.com/#docs/promise

It will show your reading progress for current post.

4.5. Picture Lightbox

A plugin for better experience of displaying pictures.

Example Usage:

  ![](path_to_image)


  ![](path_to_image)
  *Here is desc*

5. Trouble Shooting

I’m trying to keep this project as simple as possible, but if you still get stuck into any problem, please raise a issue in Github. I may check it if I got time.

6. License

MIT

7. Donate

Donate via Alipay

8. Change Log

Change Log