docs: update docs

varunkuntal · Jun 18, 2018 · b4cbfbc · b4cbfbc
1 parent 61fad90
commit b4cbfbc
Show file tree

Hide file tree

Showing 7 changed files with 54 additions and 27 deletions.
diff --git a/README-zh.md b/README-zh.md
@@ -8,7 +8,7 @@
 
 ![TeXt Theme Details](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/TeXt-details.png)
 
-TeXt 是针对博客的一款简洁的主题，它虽然简洁但并不简单。它参考了 iOS 11 的风格，有大而突出的标题和圆润的按钮及卡片。
+TeXt 是针对个人网站、博客、项目、文档等等的一款 Jekyll 主题。它参考了 iOS 11 的风格，有大而突出的标题和圆润的按钮及卡片。
 
 [English Documentation](https://github.com/kitian616/jekyll-TeXt-theme/blob/master/README.md)
 
@@ -25,7 +25,6 @@ TeXt 是针对博客的一款简洁的主题，它虽然简洁但并不简单。
 - Google Analytics
 - 联系方式设置（Email, Facebook, Twitter, 微博, 知乎……）
 - Web 语意化
-- 网站图标的自动化工具（[gulp-svg2png](https://www.npmjs.com/package/gulp-svg2png), [gulp-to-ico](https://www.npmjs.com/package/gulp-to-ico)）
 - Color Theme
 - 数学公式（[MathJax](https://www.mathjax.org/)）
 - 流程图， 序列图，甘特图（[mermaid](https://mermaidjs.github.io/)）

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 ![TeXt Theme Details](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/TeXt-details.png)
 
-TeXt is a succinct theme for blogging. Similar to iOS 11 style, it has large and prominent titles, round buttons and cards.
+TeXt is a Jekyll theme for personal site, blog, project, documentation and so on. Similar to iOS 11 style, it has large and prominent titles, round buttons and cards.
 
 [中文文档](https://github.com/kitian616/jekyll-TeXt-theme/blob/master/README-zh.md)
 
@@ -25,7 +25,6 @@ TeXt is a succinct theme for blogging. Similar to iOS 11 style, it has large and
 - Google Analytics
 - Contact information (Email, Facebook, Twitter, Linkedin, Weibo, Zhihu, etc)
 - Semantic HTML
-- Icon automation tool ([gulp-svg2png](https://www.npmjs.com/package/gulp-svg2png), [gulp-to-ico](https://www.npmjs.com/package/gulp-to-ico))
 - Color Theme
 - Mathematical formula ([MathJax](https://www.mathjax.org/))
 - Flowchart, Sequence diagram, Gantt diagram ([mermaid](https://mermaidjs.github.io/))

diff --git a/_layouts/landing.html b/_layouts/landing.html
@@ -46,10 +46,10 @@ <h3>{{ feature.title }}</h3>
 
           {%- if feature.actions -%}
             <ul class="menu menu--center">
-              {%- for action in feature.actions -%}
-                {%- assign _type = action.type | default: 'info' -%}
-                <li><a class="button button--{{ _type }} button--rounded button--lg" href="{{ action.href }}">{{ action.text }}</a></li>
-              {%- endfor -%}
+            {%- for action in feature.actions -%}
+              {%- assign _type = action.type | default: 'info' -%}
+              <li><a class="button button--{{ _type }} button--rounded button--lg" href="{{ action.href }}">{{ action.text }}</a></li>
+            {%- endfor -%}
             </ul>
           {%- endif -%}
 
@@ -80,13 +80,19 @@ <h4>{{ item.title }}</h4>
                 </div>
 
                 {%- if item.image -%}
-                  {%- if item.image.is_row -%}
-                    <div class="content__row">
+                {%- if item.image.is_row -%}
+                  <div class="content__row">
+                {%- endif -%}
+                  {%- if item.image.href -%}
+                    <a href="{{ item.image.href }}">
                   {%- endif -%}
                       <img class="content__cover" src="{{ item.image.src }}" style="{{ item.image.style }}"></img>
-                  {%- if item.image.is_row -%}
-                    </div>
+                  {%- if item.image.href -%}
+                    </a>
                   {%- endif -%}
+                {%- if item.image.is_row -%}
+                  </div>
+                {%- endif -%}
                 {%- endif -%}
 
               </div>
@@ -100,7 +106,13 @@ <h4>{{ item.title }}</h4>
           {%- if feature.image.is_row -%}
             <div class="content__row">
           {%- endif -%}
-              <img class="content__cover" src="{{ feature.image.src }}" style="{{ feature.image.style }}"></img>
+            {%- if item.image.href -%}
+              <a href="{{ item.image.href }}">
+            {%- endif -%}
+                <img class="content__cover" src="{{ feature.image.src }}" style="{{ feature.image.style }}"></img>
+            {%- if item.image.href -%}
+              </a>
+            {%- endif -%}
           {%- if feature.image.is_row -%}
             </div>
           {%- endif -%}

diff --git a/docs/about.html b/docs/about.html
@@ -61,6 +61,7 @@
         - title: PayPal
           image:
             src: https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/tip_paypal.png
+            href: https://www.paypal.me/kitian616
             style: 'max-width: 200px; max-height: 200px'
             is_row: true
 

diff --git a/docs/assets/images/mit.png b/docs/assets/images/mit.png
diff --git a/docs/en/2.3-layouts.md b/docs/en/2.3-layouts.md
@@ -17,31 +17,36 @@ graph TB;
     ARTICLE[article]
     HOME[home]
     ARCHIVE[archive]
+    LANDING[landing]
     404[404]
     NONE-->BASE;
     BASE-->PAGE;
     PAGE-->ARTICLE;
     PAGE-->HOME;
     PAGE-->ARCHIVE;
+    PAGE-->LANDING;
     PAGE-->404;
 ```
 
 ## Base Layout
 
-Base on none.
+Base on None.
 
 ## Page Layout
 
 Base on Base Layout.
 
 | Variable          | Option Values         | Description |
 | ---               | ---                   | ---         |
-| **key**           | -                     | Unique key for the post, required by Comment and Pageviews. begin with a letter (`[A-Za-z]`) and may be followed by any number of letters, digits (`[0-9]`), hyphens (`-`), underscores (`_`), colons (`:`), and periods (`.`)|
-| **show_title**    | true(default), false  | Set as false to hide title on this page|
-| **comment**       | true(default), false  | Set as `false` to disable comment on this page|
-| **mathjax**       | true, false(default)  | Set as `true` to enable Mathjax on this page|
-| **mathjax_autoNumber** | true, false(default)  | Set as `true` to enable Mathjax autoNumber on this page|
-| **mermaid**       | true, false(default)  | Set as `true` to enable Mermaid on this page|
+| **key**           | -                     | Unique key for the post, required by Comment 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                    | Language of this page |
+| **show_header**   | true(default), false  | Set as `false` to hide header on this page |
+| **show_title**    | true(default), false  | Set as `false` to hide title on this page |
+| **full_width**    | true, false(default)  | Set as `true` to make main full width on this page |
+| **comment**       | true(default), false  | Set as `false` to disable comment on this page |
+| **mathjax**       | true, false(default)  | Set as `true` to enable Mathjax on this page |
+| **mathjax_autoNumber** | true, false(default)  | Set as `true` to enable Mathjax autoNumber on this page |
+| **mermaid**       | true, false(default)  | Set as `true` to enable Mermaid on this page |
 | **chart**         | true, false(default)  | Set as `true` to enable Chart on this page|
 | **sidebar**       | -                     | |
 | **aside**         | -                     | |
@@ -61,6 +66,10 @@ Base on Page Layout.
 
 Base on Page Layout.
 
+## Landing Layout
+
+Base on Page Layout.
+
 ## 404 Layout
 
 Base on Page Layout.
diff --git a/docs/zh/2.3-layouts.md b/docs/zh/2.3-layouts.md
@@ -18,29 +18,32 @@ graph TB;
     ARTICLE[article]
     HOME[home]
     ARCHIVE[archive]
+    LANDING[landing]
     404[404]
     NONE-->BASE;
     BASE-->PAGE;
     PAGE-->ARTICLE;
     PAGE-->HOME;
     PAGE-->ARCHIVE;
+    PAGE-->LANDING;
     PAGE-->404;
 ```
 
 ## Base 布局
 
-继承于 none.
+继承于 None。
 
 ## Page 布局
 
-继承于 Base 布局.
+继承于 Base 布局。
 
 | Variable          | Option Values         | Description |
 | ---               | ---                   | ---         |
 | **key**           | -                     | 页面的唯一标识符，供评论系统和点击量统计使用。必须以字母（`[A-Za-z]`）开头，其后可以接若干字母、数字（`[0-9]`）、连字符（`-`）、下划线（`_`）、冒号（`:`）和小数点（`.`） |
 | **lang**          | en                    | 该页的语言 |
+| **show_header**   | true(default), false  | 该页是否显示 Header， 设置为 `false` 隐藏 |
 | **show_title**    | true(default), false  | 该页是否显示标题，默认显示，设置为 `false` 隐藏 |
-| **modify_date**   | -                     | 该文章的最后修改时间, 其格式为 `YYYY-MM-DD HH:MM:SS +/-TTTT` 和 `date` 的格式相同 |
+| **full_width**    | true, false(default)  | 该页内容是否占据全部宽度，设置为 `true` 开启 |
 | **comment**       | true(default), false  | 该页是否开启评论支持，默认开启，设置为 `false` 关闭 |
 | **mathjax**       | true, false(default)  | 该页是否开启 Mathjax 公式支持，默认关闭，设置为 `true` 开启 |
 | **mathjax_autoNumber** | true, false(default)  | 该页的 Mathjax 公式是否自动编号，默认关闭，设置为 `true` 开启 |
@@ -51,19 +54,23 @@ graph TB;
 
 ## Article 布局
 
-继承于 Page 布局.
+继承于 Page 布局。
 
 | Variable          | Option Values         | Description |
 | **modify_date**   | -                     | 该文章的最后修改时间, 其格式为 `YYYY-MM-DD HH:MM:SS +/-TTTT` 和 `date` 的格式相同 |
 
 ## Home 布局
 
-继承于 Page 布局.
+继承于 Page 布局。
 
 ## Archive 布局
 
-继承于 Page 布局.
+继承于 Page 布局。
+
+## Landing 布局
+
+继承于 Page 布局。
 
 ## 404 布局
 
-继承于 Page 布局.
+继承于 Page 布局。