doc: update readme, _config comment, fix test post spelling error

cnfeat · Dec 9, 2017 · 22181a1 · 22181a1
1 parent 3dfca35
commit 22181a1
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 54 deletions.
diff --git a/README.md b/README.md
@@ -102,7 +102,7 @@ bundle exec jekyll serve -H 0.0.0.0
 
 ### 多语言
 
-该主题支持 English、简体中文和繁體中文，只需在 ./\_config.yml 中设置对应 `lang` 项即可。设置后整个网站的主题文字（导航，阅读更多，文章数统计，日期格式，文章协议等等）会变为设置的语言，多语言的配置文件为 ./_data/locale.yml，你可以自由的修改、增加语言。
+该主题支持 English、简体中文和繁體中文，只需在 ./\_config.yml 中设置对应 `lang` 项即可。设置后整个网站的主题文字（导航，阅读更多，文章数统计，日期格式，文章协议等等）会变为设置的语言，多语言的配置文件为 ./_data/locale.yml，你可以自由的修改和增加语言。
 
 另外，该主题也支持对某篇文章（页面）单独设置语言，只需在 Markdown 或页面 HTML 文件的头信息中设置 `lang` 项，其优先级高于 ./\_config.yml 中设置的值。设置后该文章（页面）的主题文字会变为头信息中设置的语言。
 

diff --git a/_config.demo.yml b/_config.demo.yml
@@ -11,6 +11,8 @@
 #    |  |  \   --. /  .'.  \  |  |
 #    `--'   `----''--'   '--' `--'
 
+# config file for demo site, delete it if you want.
+
 ## Base settings ##
 url: https://tianqi.name #the base hostname & protocol for your site e.g. https://www.someone.com
 baseurl: /jekyll-TeXt-theme

diff --git a/_config.dev.yml b/_config.dev.yml
@@ -11,6 +11,8 @@
 #    |  |  \   --. /  .'.  \  |  |
 #    `--'   `----''--'   '--' `--'
 
+# config file for development, delete it if you want.
+
 ## Base settings ##
 # url:  #the base hostname & protocol for your site e.g. https://www.someone.com
 baseurl: /

diff --git a/_data/locale.yml b/_data/locale.yml
@@ -1,78 +1,78 @@
 NAV:
   HOME:
-    en:      Home
-    zh:      主页
-    zh-Hans: 主页
-    zh-Hant: 主頁
+    en:      "Home"
+    zh:      "主页"
+    zh-Hans: "主页"
+    zh-Hant: "主頁"
   ALL:
-    en:      All
-    zh:      归档
-    zh-Hans: 归档
-    zh-Hant: 歸檔
+    en:      "All"
+    zh:      "归档"
+    zh-Hans: "归档"
+    zh-Hant: "歸檔"
   RSS:
-    en:      RSS
-    zh:      RSS
-    zh-Hans: RSS
-    zh-Hant: RSS
+    en:      "RSS"
+    zh:      "RSS"
+    zh-Hans: "RSS"
+    zh-Hant: "RSS"
 
 READMORE:
-  en:      Click to read more ...
-  zh:      点我阅读更多...
-  zh-Hans: 点我阅读更多...
-  zh-Hant: 「點我閱讀更多」
+  en:      "Click to read more ..."
+  zh:      "点我阅读更多..."
+  zh-Hans: "点我阅读更多..."
+  zh-Hant: "「點我閱讀更多」"
 
-COPYRIGHT_DATES: 2015 - 2017
+COPYRIGHT_DATES: "2015 - 2017"
 
 LAST_UPDATED:
-  en:      Last updated
-  zh:      更新于
-  zh-Hans: 更新于
-  zh-Hant: 更新於
+  en:      "Last updated"
+  zh:      "更新于"
+  zh-Hans: "更新于"
+  zh-Hant: "更新於"
 
 ARTICLE_DATE_FORMAT:
-  en:      '%b %d, %Y'
-  zh:      '%Y年 %m月%d日'
-  zh-Hans: '%Y年 %m月%d日'
-  zh-Hant: '%Y年 %m月%d日'
+  en:      "%b %d, %Y"
+  zh:      "%Y年 %m月%d日"
+  zh-Hans: "%Y年 %m月%d日"
+  zh-Hant: "%Y年 %m月%d日"
 
 ARTICLE_LIST_DATE_FORMAT:
-  en:      '%b %d'
-  zh:      '%m月%d日'
-  zh-Hans: '%m月%d日'
-  zh-Hant: '%m月%d日'
+  en:      "%b %d"
+  zh:      "%m月%d日"
+  zh-Hans: "%m月%d日"
+  zh-Hant: "%m月%d日"
 
 STATISTICS:
-  en:      '[POST_COUNT] post articles, [PAGE_COUNT] pages.'
-  zh:      共计 [POST_COUNT] 篇文章, [PAGE_COUNT] 页。
-  zh-Hans: 共计 [POST_COUNT] 篇文章, [PAGE_COUNT] 页。
-  zh-Hant: 共計 [POST_COUNT] 篇文章, [PAGE_COUNT] 頁。
+  en:      "[POST_COUNT] post articles, [PAGE_COUNT] pages."
+  zh:      "共计 [POST_COUNT] 篇文章, [PAGE_COUNT] 页。"
+  zh-Hans: "共计 [POST_COUNT] 篇文章, [PAGE_COUNT] 页。"
+  zh-Hant: "共計 [POST_COUNT] 篇文章, [PAGE_COUNT] 頁。"
 
 LICENSE_ANNOUNCE:
-  en:      This work is licensed under a [LICENSE] license.
-  zh:      本文遵守 [LICENSE] 许可协议。
-  zh-Hans: 本文遵守 [LICENSE] 许可协议。
-  zh-Hant: 本文遵守 [LICENSE] 許可協議。
+  en:      "This work is licensed under a [LICENSE] license."
+  zh:      "本文遵守 [LICENSE] 许可协议。"
+  zh-Hans: "本文遵守 [LICENSE] 许可协议。"
+  zh-Hant: "本文遵守 [LICENSE] 許可協議。"
 
 LICENSE_INTRO:
   en:
-  zh:      欢迎转载，转载需注明出处，且禁止用于商业目的。
-  zh-Hans: 欢迎转载，转载需注明出处，且禁止用于商业目的。
-  zh-Hant: 歡迎轉載，轉載需註明出處，且禁止用於商業目的。
+  zh:      "欢迎转载，转载需注明出处，且禁止用于商业目的。"
+  zh-Hans: "欢迎转载，转载需注明出处，且禁止用于商业目的。"
+  zh-Hant: "歡迎轉載，轉載需註明出處，且禁止用於商業目的。"
 
 POST_ON_GITHUB:
-  en:      View this POST on Github.
-  zh:      在 Github 上查阅此文。
-  zh-Hans: 在 Github 上查阅此文。
-  zh-Hant: 在 Github 上查閱此文。
+  en:      "View this POST on Github."
+  zh:      "在 Github 上查阅此文。"
+  zh-Hans: "在 Github 上查阅此文。"
+  zh-Hant: "在 Github 上查閱此文。"
 
 FOLLOW_ME:
-  en:      Follow me on [NAME].
-  zh:      在 [NAME] 上关注我。
-  zh-Hans: 在 [NAME] 上关注我。
-  zh-Hant: 在 [NAME] 上關注我。
+  en:      "Follow me on [NAME]."
+  zh:      "在 [NAME] 上关注我。"
+  zh-Hans: "在 [NAME] 上关注我。"
+  zh-Hant: "在 [NAME] 上關注我。"
 
 EMAIL_ME:
-  en:      Send me Email.
-  zh:      给我发邮件。
-  zh-Hans: 给我发邮件。
-  zh-Hant: 給我發郵件。
+  en:      "Send me Email."
+  zh:      "给我发邮件。"
+  zh-Hans: "给我发邮件。"
+  zh-Hant: "給我發郵件。"
diff --git a/test/_posts/2017-10-12-english.md b/test/_posts/2017-10-12-english.md
@@ -9,7 +9,7 @@ lang: en
 
 > From Wikipedia, the free encyclopedia
 
-**Markdown** is a lightweight markup language with plain text formatting syntax. It is designed so that it can be converted to HTMLand many other formats using a tool by the same name. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor. As the initial description of Markdown contained ambiguities and unanswered questions, many implementations and extensions of Markdown appeared over the years to answer these issues.
+**Markdown** is a lightweight markup language with plain text formatting syntax. It is designed so that it can be converted to HTML and many other formats using a tool by the same name. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor. As the initial description of Markdown contained ambiguities and unanswered questions, many implementations and extensions of Markdown appeared over the years to answer these issues.
 
 <!--more-->