Welcome to RiinoSite3! [doc]

Features of RiinoSite3 Blog

Last modified by RiinoSite on January 27, 2020 jekyll doc


You’ll find this post in your _posts directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run jekyll serve, while Bundle exec jekyll serve is recommended, which launches a web server and auto-regenerates your site when a file is updated.

To add new posts, simply add a file in the _posts directory that follows the convention YYYY-MM-DD-name-of-post.ext and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.


  • Auto archive based on tags management
  • Support custom page from origin jekyll
  • Attribution control via yaml data:
    • Optional TOC style configuration : inline, hidden, auto
    • Hide article in home page
    • Make article pinned at home page
    • Mark a custom status symbol
  • Auto/Manual Dark/Light Mode
  • Responsive design, optimized for mobile devices
  • Global search bar
  • xml subscribe
  • Code highlights & Optional Latex support
  • Optional Mermaid support
  • Multilanguage Support
  • Emoji Support

Ymal Configurations

TOC is enabled automatically, you can set such yaml head to disable it with toc:false. When enabled, a toc at top of the article or the sidebar will be created automatically, and you do not need to add anything, any standard markdown titles will be recognized.

You can edit these attribution in yaml data of your markdown file:

layout: post
title:  "Welcome to RiinoSite3!"
subtitle: "Features of RiinoSite3 Blog" #optional 
author: "RiinoSite"    #optional
date:   2020-03-01 17:08:09 +0800
tags:           #optional
- jekyll 
- doc
status: doc     #optional,if status is 'WIP', will display a WIP banner
last-modify: 2020-01-04 10:30:00 +0000 #optional
toc: true       #default: true
sticky : true   #default: false
hide: false     #default: false (hide from Home page only)
mathjax: true   #default: true
mermaid: true   #default: true
banner-title: RiinoSite Blog #optional
banner-subtitle: Readme.md #optional, must be with banner-title
# toc options: inline, true, false

Also, tags is enabled in archive page. Current version do not support space in tag.

To edit min & max level of generated outline, please check _config.yml. Max level is 3 now.

*You have to manually input last modify date since github page do not support related plugins. (https://tomkadwill.com/adding-last-modified-date-to-jekyll)

Content Scripts

Code Highlight

Code highlight is supported by rouge.

def print_hi(name)
  puts "Hi, #{name}"
#=> prints 'Hi, Tom' to STDOUT.


Latex formatter is supported by mathjax, such latex block need two extra enter to create isolated paragraph.


To use inline latex like $\theta$ , $\pi$ , $\frac{18^2}{5}$, please check the config in head label, which is supposed to be:

<script type="text/x-mathjax-config">
        tex2jax: {
        skipTags: ['script', 'noscript', 'style', 'textarea', 'pre'],
        inlineMath: [['$','$']]
<script type="text/javascript"


UML Seq Diagram


Alice->>John: Hello John, how are you?
loop Healthcheck
    John->>John: Fight against hypochondria
Note right of John: Rational thoughts!
     John-->>Alice: Great!
     John->>Bob   : How about you?
     Bob-->>John  : Jolly good!

Gantt Diagram


section Section
          Completed: done,   des1,       2014-01-06, 2014-01-08
          Active   : active, des2,       2014-01-07, 3d
         Parallel 1        : des3,   after des1, 1d
         Parallel 2        : des4,   after des1, 1d
         Parallel 3        : des5,   after des3, 1d
         Parallel 4        : des6,   after des4, 1d

Pie Chart


  title Key elements in Product X
  "Calcium" : 42.96
  "Potassium" : 50.05
  "Magnesium" : 10.01
  "Iron" :  5

Language & Quote

Currently we don’t fully support Chinese display.

English Word Display Test 中文语言显示测试/中文語言顯示測試 日本語表示テスト/にほんごひょうじテスト


Gone camping! :tent: Be back soon.

That is so funny! :joy:

Dev Backlog

Please visit our dynamic blog of dev routine

Jekyll Doc

Check out the Jekyll docs for more info on how to get the most out of Jekyll. File all bugs/feature requests at Jekyll’s GitHub repo. If you have questions, you can ask them on Jekyll Talk.