docs: update

ZeroneCat · Jan 11, 2019 · a17af8e · a17af8e
1 parent d268a69
commit a17af8e
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 13 deletions.
diff --git a/docs/_docs/en/1.1-quick-start.md b/docs/_docs/en/1.1-quick-start.md
@@ -16,14 +16,18 @@ In this document, you will learn how to **install the theme**, **setup your site
 
 To install it with common method, all you need to do is copying all the theme files to your project. There are several ways to do so:
 
-1. Clone [jekyll-TeXt-theme](https://github.com/kitian616/jekyll-TeXt-theme) from github:
+1. Clone [jekyll-TeXt-theme](https://github.com/kitian616/jekyll-TeXt-theme) from github.
+
+   **Clone with HTTPS:**
 
    ```bash
-   $ git clone git@github.com:kitian616/jekyll-TeXt-theme.git
+   $ git clone https://github.com/kitian616/jekyll-TeXt-theme.git
    ```
 
+   **Clone with SSH:**
+
    ```bash
-   $ git clone https://github.com/kitian616/jekyll-TeXt-theme.git
+   $ git clone git@github.com:kitian616/jekyll-TeXt-theme.git
    ```
 
 1. Download and unzip the file to your Jekyll site directory.

diff --git a/docs/_docs/en/2.1-configuration.md b/docs/_docs/en/2.1-configuration.md
@@ -229,7 +229,7 @@ paginate_path: /page:num # don't change this unless for special need
 
 ## Sources
 
-TeXt use CDN[^cdn] for speed improvements, You can choose [BootCDN](http://www.bootcdn.cn/)(default) or [unpkg](https://unpkg.com/) as your site’s CDN provider, both of them are open source and free.
+TeXt use CDN[^cdn] for speed improvements, You can choose [BootCDN](http://www.bootcdn.cn/) (default) or [unpkg](https://unpkg.com/) as your site’s CDN provider, both of them are open source and free.
 
 If your website is mainly for Chinese, just use BootCDN.
 

diff --git a/docs/_docs/en/4.4-image.md b/docs/_docs/en/4.4-image.md
@@ -7,7 +7,7 @@ key: docs-image
 | Type | Class Names |
 | ---- | ---- |
 | **base**  | image |
-| **size**  | image\-\-md(default), image\-\-xs, image\-\-sm, image\-\-lg, image\-\-xl |
+| **size**  | image\-\-md (default), image\-\-xs, image\-\-sm, image\-\-lg, image\-\-xl |
 
 ## Size
 

diff --git a/docs/_docs/en/4.5-button.md b/docs/_docs/en/4.5-button.md
@@ -9,7 +9,7 @@ key: docs-button
 | **base**  | button |
 | **type**  | button\-\-primary, button\-\-secondary, button\-\-success, button\-\-info, button\-\-warning, button\-\-error, button\-\-outline\-primary, button\-\-outline\-secondary, button\-\-outline\-success, button\-\-outline\-info, button\-\-outline\-warning, button\-\-outline\-error |
 | **shape** | button\-\-pill, button\-\-rounded, button\-\-circle |
-| **size**  | button\-\-md(default), button\-\-xs, button\-\-sm, button\-\-lg, button\-\-xl |
+| **size**  | button\-\-md (default), button\-\-xs, button\-\-sm, button\-\-lg, button\-\-xl |
 
 ## Type
 

diff --git a/docs/_docs/en/4.8-hero.md b/docs/_docs/en/4.8-hero.md
@@ -82,7 +82,7 @@ key: docs-hero
 </div>
 
 ```html
-<div class="hero hero--dark" style='background-image: url("");'>
+<div class="hero hero--dark" style='background-image: url("path-to-image");'>
   <div class="hero__content">
     <h3>Hero</h3>
   </div>
@@ -98,7 +98,7 @@ key: docs-hero
 </div>
 
 ```html
-<div class="hero hero--dark" style='background-image: url("");'>
+<div class="hero hero--dark" style='background-image: url("path-to-image");'>
   <div class="hero__content">
     <h3>Hero</h3>
     <p>...</p>
@@ -117,7 +117,7 @@ key: docs-hero
 </div>
 
 ```html
-<div class="hero hero--dark" style='height: 500px; background-image: url("");'>
+<div class="hero hero--dark" style='height: 500px; background-image: url("path-to-image");'>
   <div class="hero__content">
     <h3>Hero</h3>
     <p>...</p>
@@ -136,7 +136,7 @@ key: docs-hero
 </div>
 
 ```html
-<div class="hero hero--center hero--dark" style='background-image: url("");'>
+<div class="hero hero--center hero--dark" style='background-image: url("path-to-image");'>
   <div class="hero__content">
     <h3>Hero</h3>
     <p>...</p>
@@ -155,7 +155,7 @@ key: docs-hero
 ```html
 <style>
   .hero-example--linear-gradient {
-    background-image: linear-gradient(135deg, rgba(255, 69, 0, .5), rgba(255, 197, 0, .2)), url("");
+    background-image: linear-gradient(135deg, rgba(255, 69, 0, .5), rgba(255, 197, 0, .2)), url("path-to-image");
   }
 </style>
 

diff --git a/docs/_docs/zh/1.1-quick-start.md b/docs/_docs/zh/1.1-quick-start.md
@@ -18,12 +18,16 @@ TeXt 是一款 100% 兼容 GitHub Pages 的 Jekyll 主题，你可以通过 Fork
 
 1. 从 GitHub 克隆 [jekyll-TeXt-theme](https://github.com/kitian616/jekyll-TeXt-theme) 项目:
 
+   **通过 HTTPS 方式克隆：**
+
    ```bash
-   $ git clone git@github.com:kitian616/jekyll-TeXt-theme.git
+   $ git clone https://github.com/kitian616/jekyll-TeXt-theme.git
    ```
 
+   **通过 SSH 方式克隆：**
+
    ```bash
-   $ git clone https://github.com/kitian616/jekyll-TeXt-theme.git
+   $ git clone git@github.com:kitian616/jekyll-TeXt-theme.git
    ```
 
 1. 下载主题压缩包并解压到你的项目目录中：