docs: update

zjl1053318729 · Jan 6, 2019 · 63658f2 · 63658f2
1 parent cb60204
commit 63658f2
Show file tree

Hide file tree

Showing 17 changed files with 172 additions and 185 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -52,7 +52,7 @@
 
 ### Bug Fixes
 
-- replace Lenna test image
+- Replace Lenna test image
 
 ## 2.1.0 (2018-08-26)
 
@@ -120,7 +120,7 @@ Breaking changes, please check [Update from 1.x to 2.x](https://tianqi.name/jeky
 - New TOC style
 - Gitalk support (@WangQiru)
 - Mermaid support
-- `site.paths` & `site.nav_lists` support absolute URL
+- `site.paths` and `site.nav_lists` configs support absolute URL
 
 ## 1.4.2 (2017-12-10)
 
@@ -143,7 +143,7 @@ Breaking changes, please check [Update from 1.x to 2.x](https://tianqi.name/jeky
 
 ### Enhancements
 
-- Multi-language support
+- Internationalization
 
 ### Bug Fixes
 
@@ -180,7 +180,7 @@ Breaking changes, please check [Update from 1.x to 2.x](https://tianqi.name/jeky
 
 ### Bug Fixes
 
-- View count display error when the post key include `-` (@yuxianda)
+- Pageview display error when the post key include `-` (@yuxianda)
 - Email url error
 
 ## 1.2.0 (2017-10-22)

diff --git a/README-zh.md b/README-zh.md
@@ -67,6 +67,7 @@ TeXt 使用 [Tomorrow](https://github.com/chriskempson/tomorrow-theme) 作为它
 - [布局](https://tianqi.name/jekyll-TeXt-theme/docs/zh/layouts)
 - [Logo 和 Favicon](https://tianqi.name/jekyll-TeXt-theme/docs/zh/logo-and-favicon)
 - [作者](https://tianqi.name/jekyll-TeXt-theme/docs/zh/authors)
+- [国际化](https://tianqi.name/jekyll-TeXt-theme/docs/zh/i18n)
 
 ### 内容
 

diff --git a/README.md b/README.md
@@ -67,6 +67,7 @@ TeXt use [Tomorrow](https://github.com/chriskempson/tomorrow-theme) as the highl
 - [Layouts](https://tianqi.name/jekyll-TeXt-theme/docs/en/layouts)
 - [Logo and Favicon](https://tianqi.name/jekyll-TeXt-theme/docs/en/logo-and-favicon)
 - [Authors](https://tianqi.name/jekyll-TeXt-theme/docs/en/authors)
+- [Internationalization](https://tianqi.name/jekyll-TeXt-theme/docs/en/i18n)
 
 ### Content
 

diff --git a/_includes/footer.html b/_includes/footer.html
@@ -22,9 +22,11 @@
         {%- include author-links.html author=_site_author -%}
       </div>
     </div>
+    {%- include snippets/get-locale-string.html key='COPYRIGHT_DATES' -%}
+    {%- assign _locale_copyright_dates = __return -%}
     <div class="site-info mt-2">
       <div>
-        © {{ site.title }} {{ site.data.locale.COPYRIGHT_DATES }},
+        © {{ site.title }} {{ _locale_copyright_dates }},
         Powered by <a title="Jekyll is a simple, blog-aware, static site generator." href="http://jekyllrb.com/">Jekyll</a> & <a
         title="TeXt is a super customizable Jekyll theme." href="https://github.com/kitian616/jekyll-TeXt-theme">TeXt Theme</a>.
       </div>

diff --git a/_sass/components/_article-header.scss b/_sass/components/_article-header.scss
@@ -7,6 +7,9 @@
   header, h1 {
     display: inline;
   }
+  h1 {
+    word-wrap: break-word;
+  }
   .split-space {
     @include user-select(none);
   }

diff --git a/about.md b/about.md
@@ -32,7 +32,7 @@ TeXt is a super customizable Jekyll theme for personal site, team site, blog, pr
 - Semantic HTML
 - Skins
 - Highlight Theme
-- Multi-language support
+- Internationalization
 - Search
 - Table of contents
 - Authors (Email, Facebook, Twitter, Linkedin, Weibo, Zhihu, etc)

diff --git a/docs/_docs/en/2.1-configuration.md b/docs/_docs/en/2.1-configuration.md
@@ -151,7 +151,7 @@ repository: user_name/repo_name
 
 ## Post
 
-### Excerpt `Before Version 2.2.0`{:.error}
+### Excerpt
 
 Each post automatically takes the first block of text, from the beginning of the content to the first occurrence of `excerpt_separator`, and sets it as the post’s excerpt.
 
@@ -160,14 +160,14 @@ The post’s excerpt is show in the articles list in the home layout. There are
 | Type Name | Description |
 | --- | --- |
 | **text** | the excerpt are plain text that filters out all non-text elements (such as title, link, list, table, picture, etc.) and only show 350 characters most. |
-| **html** | the excerpt are HTML document just like the content of the article, This will show all the content by default, except adding `<!--more-->` in the article Markdown file, You can find more info [HERE](https://jekyllrb.com/docs/posts/#post-excerpts).  |
+| **html** | the excerpt are HTML document just like the content of the article, This will show all the content by default, except adding `<!--more-->` in the article Markdown file, You can find more info [HERE](https://jekyllrb.com/docs/posts/#post-excerpts). |
 
 ```yaml
 excerpt_separator: <!--more-->
 excerpt_type: text # text (default), html
 ```
 
-This setting has been **MOVED** to the YAML Front Matter of Articles and Home Layout **Since Version 2.2.0**, You can find more information [HERE](https://tianqi.name/jekyll-TeXt-theme/docs/en/layouts#articles-layout).
+This setting has been **MOVED** to the YAML Front Matter of Articles and home layout **Since Version 2.2.0**, You can find more information [HERE](https://tianqi.name/jekyll-TeXt-theme/docs/en/layouts#articles-layout).
 {:.error}
 
 ### License
@@ -219,7 +219,7 @@ Settings for [Jekyll Paginate](https://github.com/jekyll/jekyll-paginate) plugin
 paginate: 8
 ```
 
-The number should be the maximum number of Posts you’d like to be displayed per-page in the generated site.
+The number should be the maximum number of posts you’d like to be displayed per-page in the generated site.
 
 You may also specify the destination of the pagination pages:
 
@@ -241,11 +241,11 @@ sources: bootcdn # bootcdn (default), unpkg
 
 ## Sharing
 
-| Name | Sharing Provider |
-| --- | --- |
-| **addtoany** | [AddToAny](https://www.addtoany.com/) |
-| **addthis** | [AddThis](https://www.addthis.com/) |
-| **custom** |  |
+| Name | Sharing Provider | Version |
+| --- | --- | --- |
+| **addtoany** | [AddToAny](https://www.addtoany.com/) | 2.2.2 |
+| **addthis** | [AddThis](https://www.addthis.com/) | 2.2.3 |
+| **custom** | | |
 
 ### AddToAny
 
@@ -268,12 +268,12 @@ You NEED set `sharing` variable as `true` in the page’s YAML Front Matter to e
 
 ## Comments
 
-| Name | Comments Provider |
-| --- | --- |
-| **disqus** | [Disqus](https://disqus.com/) |
-| **gitalk** | [Gitalk](https://github.com/gitalk/gitalk/) |
-| **valine** | [Valine](https://valine.js.org/en/) |
-| **custom** |  |
+| Name | Comments Provider | Version |
+| --- | --- | --- |
+| **disqus** | [Disqus](https://disqus.com/) | |
+| **gitalk** | [Gitalk](https://github.com/gitalk/gitalk/) | |
+| **valine** | [Valine](https://valine.js.org/en/) | 2.2.4 |
+| **custom** | | |
 
 ### Disqus
 

diff --git a/docs/_docs/en/2.3-layouts.md b/docs/_docs/en/2.3-layouts.md
@@ -33,31 +33,31 @@ Base on None.
 
 Base on Base Layout.
 
-| Variable          | Option Values         | Description |
-| ---               | ---                   | ---         |
-| **mode**          | normal (default), immersive | mode of the page. |
-| **type**          | webpage (default), article | type of the page, used by [schema.org](https://schema.org/) markup. |
-| **key**           | `!!str`               | Unique key for the post, required by Comments and Pageview. begin with a letter (`[A-Za-z]`) and may be followed by any number of letters, digits (`[0-9]`), hyphens (`-`), underscores (`_`), colons (`:`), and periods (`.`). |
-| **lang**          | en (default), zh, zh-Hans, zh-Hant | Language of this page. |
-| **author**        | `!!map`               | Assign one of the authors in *authors.yml* to a post or page, see [Authors](https://tianqi.name/jekyll-TeXt-theme/docs/en/authors) for detail. |
-| **show_title**    | true (default), false | Set as `false` to hide title on this page. |
-| **show_edit_on_github** | true, false (default) | Set as `true` to show “Edit on Github” button. you need set `repository` and `repository_tree` in *_config.yml* first. |
-| **show_date**     | true (default), false | Set as `false` to hide date on this page. |
-| **show_tags**     | true (default), false | Set as `false` to hide tags on this page. |
-| **full_width**    | true, false (default) | Set as `true` to make main full width on this page. |
-| **pageview**      | true, false (default) | Set as `true` to enable pageview on this page. |
-| **comment**       | true (default), false | Set as `false` to disable comment on this page. |
-| **mathjax**       | true, false           | Set as `true` to enable Mathjax on this page. |
-| **mathjax_autoNumber** | true, false      | Set as `true` to enable Mathjax autoNumber on this page. |
-| **mermaid**       | true, false           | Set as `true` to enable Mermaid on this page. |
-| **chart**         | true, false           | Set as `true` to enable Chart on this page. |
-| **cover**         | `!!str`               | Url of the cover image. |
-| **header**        | false, `!!map`        | Set as `false` to hide header on this page. |
-| **article_header**| `!!map`               | |
-| **aside**         | `!!map`               | |
-| **sidebar**       | `!!map`               | |
-| **footer**        | false                 | Set as `false` to hide footer on this page. |
-| **lightbox**      | true, false           | Set as `true` to enable lightbox (modal image gallery) for large images on this page, you can set `lightbox-ignore` class name to ignore the certain image. |
+| Variable          | Option Values         | Description | Version |
+| ---               | ---                   | ---         | ---     |
+| **mode**          | normal (default), immersive | mode of the page. | 2.2.0 |
+| **type**          | webpage (default), article | type of the page, used by [schema.org](https://schema.org/) markup. | |
+| **key**           | `!!str`               | Unique key for the post, required by Comments and Pageview. begin with a letter (`[A-Za-z]`) and may be followed by any number of letters, digits (`[0-9]`), hyphens (`-`), underscores (`_`), colons (`:`), and periods (`.`). | |
+| **lang**          | en (default), zh, zh-Hans, zh-Hant | Language of this page. | |
+| **author**        | `!!map`               | Assign one of the authors in *authors.yml* to a post or page, see [Authors](https://tianqi.name/jekyll-TeXt-theme/docs/en/authors) for detail. | 2.2.0 |
+| **show_title**    | true (default), false | Set as `false` to hide title on this page. | |
+| **show_edit_on_github** | true, false (default) | Set as `true` to show “Edit on Github” button. you need set `repository` and `repository_tree` in *_config.yml* first. | |
+| **show_date**     | true (default), false | Set as `false` to hide date on this page. | 2.2.0 |
+| **show_tags**     | true (default), false | Set as `false` to hide tags on this page. | 2.2.0 |
+| **full_width**    | true, false (default) | Set as `true` to make main full width on this page. | |
+| **pageview**      | true, false (default) | Set as `true` to enable pageview on this page. | 2.2.0 |
+| **comment**       | true (default), false | Set as `false` to disable comment on this page. | |
+| **mathjax**       | true, false           | Set as `true` to enable Mathjax on this page. | |
+| **mathjax_autoNumber** | true, false      | Set as `true` to enable Mathjax autoNumber on this page. | |
+| **mermaid**       | true, false           | Set as `true` to enable Mermaid on this page. | |
+| **chart**         | true, false           | Set as `true` to enable Chart on this page. | |
+| **cover**         | `!!str`               | Url of the cover image. | 2.2.0 |
+| **header**        | false, `!!map`        | Set as `false` to hide header on this page. | 2.2.0 |
+| **article_header**| `!!map`               | | 2.2.0 |
+| **aside**         | `!!map`               | | |
+| **sidebar**       | `!!map`               | | |
+| **footer**        | false                 | Set as `false` to hide footer on this page. | 2.2.3 |
+| **lightbox**      | true, false           | Set as `true` to enable lightbox (modal image gallery) for large images on this page, you can set `lightbox-ignore` class name to ignore the certain image. | 2.2.4 |
 
 ### header
 
@@ -71,7 +71,7 @@ Base on Base Layout.
 | Variable          | Option Values         | Description |
 | ---               | ---                   | ---         |
 | **type**          | overlay, cover        | |
-| **align**         | left (default), center | |
+| **align**         | left (default), center| |
 | **theme**         | light (default), dark | |
 | **background_color** | `!!str`            | Available when type is `overlay`. If set to a dark color, you need set theme as 'dark'. |
 | **background_image** | `!!map`            | Available when type is `overlay`, set as `false` can overwrite `cover` to disable background image. |
@@ -107,17 +107,17 @@ Base on Base Layout.
 
 Base on Page Layout.
 
-| Variable          | Option Values         | Description |
-| ---               | ---                   | ---         |
-| **modify_date**   | `!!str`               | The last modified date of this article, the date is modified in the format `YYYY-MM-DD HH:MM:SS +/-TTTT`; hours, minutes, seconds, and timezone offset are optional. just like `date` variable. |
-| **sharing**       | true, false (default) | Set as `true` to enable Sharing on this article. |
-| **show_author_profile** | true, false (default) | Set as `true` to show author profile at the beginning of the article. |
-| **show_subscribe**| true, false (default) | Set as `true` to show subscribe info on this page. |
-| **license**       | true, false (default), CC-BY-4.0, CC-BY-SA-4.0, CC-BY-NC-4.0, CC-BY-ND-4.0 | license of the article. Set true to use `license` variable that set in *_config.yml*, set false to enable it. |
+| Variable          | Option Values         | Description | Version |
+| ---               | ---                   | ---         | ---     |
+| **modify_date**   | `!!str`               | The last modified date of this article, the date is modified in the format `YYYY-MM-DD HH:MM:SS +/-TTTT`; hours, minutes, seconds, and timezone offset are optional. just like `date` variable. | |
+| **sharing**       | true, false (default) | Set as `true` to enable Sharing on this article. | 2.2.2 |
+| **show_author_profile** | true, false (default) | Set as `true` to show author profile at the beginning of the article. | |
+| **show_subscribe**| true, false (default) | Set as `true` to show subscribe info on this page. | latest |
+| **license**       | true, false (default), CC-BY-4.0, CC-BY-SA-4.0, CC-BY-NC-4.0, CC-BY-ND-4.0 | license of the article. Set true to use `license` variable that set in *_config.yml*, set false to enable it. | |
 
 ## Articles Layout
 
-Base on Page Layout.
+Base on Page Layout, available since version **2.2.0**.
 
 | Variable          | Option Values         | Description |
 | ---               | ---                   | ---         |

diff --git a/docs/_docs/en/3.4-extensions.md b/docs/_docs/en/3.4-extensions.md
@@ -6,11 +6,12 @@ key: docs-extensions
 
 ## Audio
 
-### SoundCloud
-
-<div>{%- include extensions/soundcloud.html id='313627932' -%}</div>
+| Name        | Version |
+| ---         | ---   |
+| SoundCloud  | 2.2.2 |
+| Netease Cloud Music | 2.2.2 |
 
----
+### SoundCloud
 
 **id:**
 
@@ -34,10 +35,6 @@ key: docs-extensions
 
 Available in Chinese mainland.
 
-<div>{%- include extensions/netease-cloud-music.html id='413812448' -%}</div>
-
----
-
 **id:**
 
 ![extensions-soundcloud](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/extensions-netease-cloud-music.jpg){:style="max-height:320px"}{:.border}
@@ -58,11 +55,13 @@ Available in Chinese mainland.
 
 ## Video
 
-### YouTube
-
-<div>{%- include extensions/youtube.html id='wbY97-hdD5c' -%}</div>
+| Name        | Version |
+| ---         | ---   |
+| YouTube     | 2.2.2 |
+| TED         | 2.2.2 |
+| bilibili    | 2.2.2 |
 
----
+### YouTube
 
 **id:**
 
@@ -84,10 +83,6 @@ Available in Chinese mainland.
 
 ### TED
 
-<div>{%- include extensions/ted.html id='emily_esfahani_smith_there_s_more_to_life_than_being_happy' -%}</div>
-
----
-
 **id:**
 
 ![extensions-soundcloud](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/extensions-ted.jpg){:style="max-height:83px"}{:.border}
@@ -108,10 +103,6 @@ Available in Chinese mainland.
 
 ### bilibili (哔哩哔哩)
 
-<div>{%- include extensions/bilibili.html id='11091080' -%}</div>
-
----
-
 **id:**
 
 ![extensions-bilibili](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/extensions-bilibili.jpg){:style="max-height:190px"}{:.border}
@@ -132,11 +123,11 @@ Available in Chinese mainland.
 
 ## Slide
 
-### SlideShare
-
-<div>{%- include extensions/slideshare.html id='u9L9zDsqEWNKE1' -%}</div>
+| Name        | Version |
+| ---         | ---   |
+| SlideShare  | 2.2.2 |
 
----
+### SlideShare
 
 **id:**
 
@@ -158,11 +149,11 @@ Available in Chinese mainland.
 
 ## Demos
 
-### CodePen
-
-<div>{%- include extensions/codepen.html user='kitian616' hash='aQmWZG' default_tab='html,result' -%}</div>
+| Name        | Version |
+| ---         | ---   |
+| CodePen     | 2.2.3 |
 
----
+### CodePen
 
 **user & hash:**
 

diff --git a/docs/_docs/zh/2.1-configuration.md b/docs/_docs/zh/2.1-configuration.md
@@ -149,7 +149,7 @@ repository: user_name/repo_name
 
 ## 文章配置项
 
-### 摘要 `2.2.0 之前版本`{:.error}
+### 摘要
 
 该主题的摘要有两种模式——TEXT 模式和 HTML 模式。 当 *_config.yml* 配置项 `excerpt_type` 的值为 `text` 时是 TEXT 模式，为 `html` 时是 HTML 模式，**默认为 TEXT 模式**。
 
@@ -239,11 +239,11 @@ sources: bootcdn # bootcdn (default), unpkg
 
 ## 分享
 
-| 名称 | 分享系统提供方 |
-| --- | --- |
-| **addtoany** | [AddToAny](https://www.addtoany.com/) |
-| **addthis** | [AddThis](https://www.addthis.com/) |
-| **custom** |  |
+| 名称 | 分享系统提供方 | 最低版本 |
+| --- | --- | --- |
+| **addtoany** | [AddToAny](https://www.addtoany.com/) | 2.2.2 |
+| **addthis** | [AddThis](https://www.addthis.com/) | 2.2.3 |
+| **custom** | | |
 
 ### AddToAny
 
@@ -266,12 +266,12 @@ comments:
 
 ## 评论
 
-| 名称 | 评论系统提供方 |
-| --- | --- |
-| **disqus** | [Disqus](https://disqus.com/) |
-| **gitalk** | [Gitalk](https://github.com/gitalk/gitalk/) |
-| **valine** | [Valine](https://valine.js.org/en/) |
-| **custom** |  |
+| 名称 | 评论系统提供方 | 最低版本 |
+| --- | --- | --- |
+| **disqus** | [Disqus](https://disqus.com/) | |
+| **gitalk** | [Gitalk](https://github.com/gitalk/gitalk/) | |
+| **valine** | [Valine](https://valine.js.org/en/) | 2.2.4 |
+| **custom** | | |
 
 ### Disqus