docs: add document - configuration & writing post, update config

s-edwards · May 5, 2018 · 429be28 · 429be28
1 parent c8f0ee0
commit 429be28
Show file tree

Hide file tree

Showing 30 changed files with 665 additions and 221 deletions.
diff --git a/_config.demo.yml b/_config.demo.yml
@@ -13,14 +13,51 @@
 
 # config file for demo site, DELETE IT IF YOU WANT.
 
-text_color_theme: default #eg: default | dark | forest | ocean | chocolate | orange
-## Base settings ##
-url: https://tianqi.name #the base hostname & protocol for your site e.g. https://www.someone.com
-baseurl: /jekyll-TeXt-theme
+
+## => Site Settings
+##############################
+text_color_theme: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
+url: https://tianqi.name # the base hostname & protocol for your site e.g. https://www.someone.com
+baseurl: /jekyll-TeXt-theme # does not include hostname
 title: TeXt Theme
-description: > #this means to ignore newlines until "nav_lists:"
+description: > # this means to ignore newlines until "Language & timezone"
   TeXt Theme Demo
 
+
+# => Language and Timezone
+##############################
+lang: en # the language of your site, "en" (default, English), "zh"(简体中文), "zh-Hans"(简体中文), "zh-Hant"(繁體中文)
+timezone: Asia/Shanghai # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the available values
+
+
+## => Author and Social
+##############################
+author:
+  name: Someone
+  email: someone@somemail.com # your Email address e.g. someone@site.com
+  facebook: someone # your Facebook username
+  twitter: someone # your Twitter username
+  github: someone # your GitHub username
+  googleplus: someone # your Google+ username
+  weibo: someone # your Weibo username
+  douban: someone # your Douban username
+  linkedin: someone # your Linkedin username
+
+
+## => GitHub Repository (if the site is hosted by GitHub)
+##############################
+repository: kitian616/jekyll-TeXt-theme
+repository_tree: master
+
+
+## => Navigation
+##############################
+paths:
+  base: /
+  home: https://github.com/kitian616/jekyll-TeXt-theme/
+  # all:  /all.html
+  # rss:  /feed.xml
+
 nav_lists:
   - titles:
       en: About
@@ -29,76 +66,77 @@ nav_lists:
       zh-Hant: 關於
     url: /about.html
 
-paths:
-  base: /
-  home: https://github.com/kitian616/jekyll-TeXt-theme/
-  # all:  /all.html
-  # rss:  /feed.xml
 
-## GitHub repository (if the site is hosted by GitHub) ##
-repository: kitian616/jekyll-TeXt-theme
-repository_tree: master
 
-## Language & timezone ##
-lang: en #the language of your site, eg: en(English), zh(简体中文), zh-Hans(简体中文), zh-Hant(繁體中文)
-timezone: Asia/Shanghai #see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the available values
 
-## Author & social ##
-author:
-  name: Someone
-  email: someone@somemail.com  #your Email address e.g. someone@site.com
-  facebook: someone  #your Facebook username
-  twitter: someone  #your Twitter username
-  github: someone  #your GitHub username
-  googleplus: someone  #your Google+ username
-  weibo: someone  #your Weibo username
-  douban: someone  #your Douban username
-  linkedin: someone  #your Linkedin username
+## => Post
+##############################
+## excerpt
+excerpt_separator: <!--more-->
+excerpt_type: html # text (default), html
 
 ## TOC
 toc:
-  # selectors: 'h1,h2,h3'
+  selectors: # "h1,h2,h3" (default)
+
+## Markdown Enhancements
+
+# Mathjax
+mathjax: true # false (default), true
+mathjax_autoNumber: true # false (default), true
+
+# Mermaid
+mermaid: true # false (default), true
+
+# Chart
+chart: true # false (default), true
+
+
+## => Paginate
+##############################
+paginate: 8
+paginate_path: /page:num
+
 
-## Comment system (Disqus) ##
+## => Sources
+##############################
+sources: # bootcdn (default), unpkg
+
+
+## => Comments
+##############################
+## Disqus
 disqus:
-  # shortname:  #the Disqus shortname for the site
+  shortname: # the Disqus shortname for the site
 
-## Comment system (gitalk) ##
+## Gitalk
 # please refer to https://github.com/gitalk/gitalk for more info.
 gitalk:
-  clientID: 143666b578a416f82175 #Github Application Client ID
-  clientSecret: 1d1c0604a1a4bff9b59ab7f56724dc0e8b837775 #Github Application Client Secret
-  repository: gitalk-demo #Github repo
-  owner: kitian616 #Github repo owner
-  admin:  #Github repo owner and collaborators, only these guys can initialize github issues, IT IS A LIST.
+  clientID: 143666b578a416f82175 # Github Application Client ID
+  clientSecret: 1d1c0604a1a4bff9b59ab7f56724dc0e8b837775 # Github Application Client Secret
+  repository: gitalk-demo # Github repo
+  owner: kitian616 # Github repo owner
+  admin: # Github repo owner and collaborators, only these guys can initialize github issues, IT IS A LIST.
     - kitian616
 
-## Google Analytics ##
-ga_tracking_id: UA-71907556-1 #Google analytics id for the site
 
-## Reading quantity (LeanCloud) ##
+## => Pageview
+##############################
+## Leancloud
 leancloud:
   app_id: uAG3OhdcH8H4fxSqXLyBljA7-gzGzoHsz
   app_key: Mzf5m9skSwYVWVXhGiYMNyXs
   app_class: TeXtDemo
 
-mathjax: true
-mathjax_autoNumber: true
-mermaid: true
-chart: true
 
-## Paginate ##
-paginate: 7
-paginate_path: /page:num
-
-## Post excerpts ##
-excerpt_separator: <!--more-->
-excerpt_type: html # text | html
+## => Analytics
+##############################
+## Google Analytics
+ga_tracking_id: UA-71907556-1 #Google analytics id for the site
 
-## Sources ##
-# sources: bootcss #eg: bootcss | unpkg
 
-## Build ##
+## => Build
+##############################
 markdown: kramdown
 highlighter: rouge
 permalink: date
@@ -121,12 +159,11 @@ exclude:
   # - /test
   - /vendor
 
-## Plugins ##
+
+## => Plugins
+##############################
 plugins:
-  - jekyll-sitemap
   - jekyll-feed
   - jekyll-paginate
-  - jemoji
-
-## Server ##
-server_url: "0.0.0.0"
+  - jekyll-sitemap
+  - jemoji