Fundamental

  • Initialization with Jekyll
  • Push to Github
  • Start with several posts
  • Pick a basic theme: minima

Layouts Modification

Include folder

  • Dissemble head.html into files in _includes/head/
  • Dissemble header.html into files like _includes/svg/menu-icon.html and _includes/header/title.html

Sass folder

  • Dissemble _sass\minima\_layouts.sass into files in _sass\layouts

Site Functions

Resolution dependent layouts

  • [ ]
  • Fixed header
  • modified page layout with empty space left for the header

Multilingual

  • Define new variables for pages and posts: lang and ref
  • List out available page/post language
  • Generate posts/pages with specific language
  • Style editing for language list at header
  • Add message when mouse hovering on title according to page/post language

Abbreviation

  • Create abbreviation data: _data/abbr.yml
  • Create transformation file: _include/ref/abbr.html
  • Upgrade abbr.html: Return different reference of the abbreviation by passing variable txt
  • Upgrade abbr.html: Return different format of the abbreviation by passing variable format

Quotes

  • Include quotes.html to page and post layouts

Post Functions

Maths Display

  • Add mathjax.js to head.html
  • Define new variable for page/post to embed mathjax or not

Diagram Display

  • Add mermaid.js to head.html
  • define new varible for page/post to embed mermaid or not
  • Alternative diagram displaying method: seq-diagram.js
  • Alternative diagram displaying method: https://g.gravizo.com/svg

Table of Contents

  • Applying https://github.com/allejo/jekyll-toc directly to toc.html
  • Style editing for wiki-like toc: new css class post-toc
  • Add show/hide button for toc using javascript approach: add toc style in _sass/layouts/_post.scss and post-toc-trigger.js in assets/js which included in _includes/head/js.html
  • Set default value for all post that showing toc by default. Manually set post-toc to be false to have a post without showing toc.

Bibliography

  • Create bibliography data: _data/bib.yml
  • Create transformation file: _include/ref/bib.html