docs: update readme-en

hugdiniz · May 5, 2018 · da1775f · da1775f
1 parent 429be28
commit da1775f
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 94 deletions.
diff --git a/README-en.md b/README-en.md
@@ -8,8 +8,6 @@
 
 ![TeXt Theme Details](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/TeXt-details.png)
 
-[Demo](https://tianqi.name/jekyll-TeXt-theme/) | [English (Beta)](https://github.com/kitian616/jekyll-TeXt-theme/blob/master/README-en.md)
-
 TeXt is a succinct theme for blogging. Similar to iOS 11 style, it has large and prominent titles, round buttons and cards.
 
 ## Features
@@ -33,51 +31,9 @@ TeXt is a succinct theme for blogging. Similar to iOS 11 style, it has large and
 - RSS（[jekyll-feed](https://github.com/jekyll/jekyll-feed))
 - Multi-language support(English | Simplified Chinese | Traditional Chinese)
 
-## How To Use
-
-The easiest way is making a fork of the repository and rename it to `<username>.github.io`, then you can clone it to local, commit your changes and push.
-
-And also, you can get the source code of the theme at the [release page](https://github.com/kitian616/jekyll-TeXt-theme/releases).
-
-### Configuration
-
-Add your information in the ./_config.yml file, such as your name, contact, title of the site and so on.
-
-Write your brief introduction in the ./about.md file.
-
-### Writing Posts
-
-To create a new post, all you need to do is create a file in the ./_posts directory. the blog post files need to be named as the format `YEAR-MONTH-DAY-title.MARKUP`, for example `2011-12-31-new-years-eve-is-awesome.md`. You can find more info at [Jekyll: Writing Posts](https://jekyllrb.com/docs/posts/).
-
-### Excerpt
-
-There are two excerpt types: TEXT type and HTML type. You can change it by setting the value of `excerpt_type` in the ./\_config.yml file.
-
-| excerpt_type | type | description |
-| --- | --- | --- |
-| text | 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 | 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 at [Jekyll: Post#post-excerpts](https://jekyllrb.com/docs/posts/#post-excerpts).  |
-
-### Installation Development Environment (not Necessary)
-
-Find more info at [Jekyll: Installation](https://jekyllrb.com/docs/installation/).
-
-### Development Server (not Necessary)
-
-if you Installed Node.js, you can start a development server by running `npm run dev` at the root path of the repository.
+## Color Themes
 
-if not, just run:
-
-```console
-bundle exec jekyll serve -H 0.0.0.0
-```
-after the command finished, you can visit [http://localhost:4000/](http://localhost:4000/) to see the page.
-
-You can find more info at [Jekyll: Usage](https://jekyllrb.com/docs/usage/).
-
-## Advanced
-
-### Color Theme
+You can choose these 6 built-in color themes below:
 
 | `default` | `dark` | `forest` |
 | --- |  --- | --- |
@@ -87,43 +43,19 @@ You can find more info at [Jekyll: Usage](https://jekyllrb.com/docs/usage/).
 | --- |  --- | --- |
 | ![ocean](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_ocean.png) | ![chocolate](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_chocolate.png) | ![orange](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_orange.png) |
 
-### Icons
-
-This theme comes with a "ginkgo leaf" icon, you can replace it with your own icon. The site's icons are located in the ./favicon.ico and ./assets/images/logo directories. You can see the logo directory has a lot of png files and a svg vector file. Those png images are actually images of different sizes generated from svg vector images that may used in some scenes, such as pinned to the screen in OS and Android and tiles in Windows 10.
-
-This theme provides an automated script for automatically generating favicon and png files from svg vector graphics. What you have to do is:
-
-1. Install Node.js
-
-2. Run `npm i` command at the root directory.
-
-3. Replacing the logo.svg file in the ./assets/images/logo directory.
-
-4. Run `npm run artwork` command. after it finished, the favicon and png files will be replaced by the new logo.svg generated files.
-
-### Comment
-
-### Reading Quantity
-
-### Google Analytics
-
-### Front Matter Enhancement
+## Documentation
 
-In addition to Jekyll's front matters, the theme adds some unique front matters.
+- [Quick Start](https://tianqi.name/jekyll-TeXt-theme/test/document/2018/05/01/quick-start.html)
+- [Configuration](https://tianqi.name/jekyll-TeXt-theme/test/document/2018/04/20/configuration.html)
+- [Writing Posts](https://tianqi.name/jekyll-TeXt-theme/test/document/2018/04/10/writing-posts.html)
 
-| variable      | option values | description |
-| ---           | ---           | ---         |
-| key           | | |
-| picture_frame | shadow        | |
-| modify_date   | | |
-| comment       | true/false    | |
-| mathjax       | true/false    | |
-| mermaid       | true/false    | |
-| chart       | true/false    | |
+## Demo Pages
 
-### Other Resource
+| Name | Description |
+| --- | --- |
+| [Home](https://tianqi.name/jekyll-TeXt-theme/) | Home page with posts list |
+| [Archive](https://tianqi.name/jekyll-TeXt-theme/all.html) | You can filter tags and search here |
 
-## Examples
+## License
 
-- [Demo](https://tianqi.name/jekyll-TeXt-theme/)
-- [Qi's blog](https://tianqi.name/blog/)
+TeXt Theme is [MIT licensed](https://github.com/kitian616/jekyll-TeXt-theme/blob/master/LICENSE).
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)
 
-[Demo](https://tianqi.name/jekyll-TeXt-theme/) | [English (Beta)](https://github.com/kitian616/jekyll-TeXt-theme/blob/master/README-en.md)
+[Demo](https://tianqi.name/jekyll-TeXt-theme/) | [English](https://github.com/kitian616/jekyll-TeXt-theme/blob/master/README-en.md)
 
 TeXt is a succinct theme for blogging.
 

diff --git a/test/_posts/2016-07-07-images.md b/test/_posts/2016-07-07-images.md
@@ -5,7 +5,7 @@ key: 20160707
 tags: Jekyll English
 ---
 
-![](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.png)
+![](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.jpg)
 
 smile, smile, smile. :smile:
 
@@ -17,31 +17,31 @@ smile, smile, smile. :smile:
 
 ## With ALT
 
-![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.png)
+![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.jpg)
 
 **markdown:**
 
     ![Lenna](path-to-image.jpg)
 
 ## With Title
 
-![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.png "Lenna")
+![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.jpg "Lenna")
 
 **markdown:**
 
     ![Lenna](path-to-image.jpg "Lenna")
 
 ## Specify Width and Height
 
-![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.png "Lenna@128x128"){:width="128px" height="128px"}
+![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.jpg "Lenna@128x128"){:width="128px" height="128px"}
 
 **markdown:**
 
     ![Lenna](path-to-image.jpg){:width="128px" height="128px"}
 
 ---
 
-![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.png "Lenna@64x64"){:width="64px" height="64px"}
+![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.jpg "Lenna@64x64"){:width="64px" height="64px"}
 
 **markdown:**
 

diff --git a/test/_posts/2017-08-08-additional-styles.md b/test/_posts/2017-08-08-additional-styles.md
@@ -40,55 +40,55 @@ Error Text.
 
 ### Border
 
-![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.png "Lenna_border"){:.border}
+![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.jpg "Lenna_border"){:.border}
 
 **markdown:**
 
     ![Lenna](path-to-image.jpg){:.border}
 
 ### Shadow
 
-![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.png "Lenna_shadow"){:.shadow}
+![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.jpg "Lenna_shadow"){:.shadow}
 
 **markdown:**
 
     ![Lenna](path-to-image.jpg){:.shadow}
 
 ### Rounded
 
-![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.png "Lenna_rounded"){:.rounded}
+![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.jpg "Lenna_rounded"){:.rounded}
 
 **markdown:**
 
     ![Lenna](path-to-image.jpg){:.rounded}
 
 ### Circle
 
-![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.png "Lenna_circle"){:.circle}
+![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.jpg "Lenna_circle"){:.circle}
 
 **markdown:**
 
     ![Lenna](path-to-image.jpg){:.circle}
 
 ### Mixture
 
-![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.png "Lenna_border+rounded"){:.border.rounded}
+![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.jpg "Lenna_border+rounded"){:.border.rounded}
 
 **markdown:**
 
     ![Lenna](path-to-image.jpg){:.border.rounded}
 
 ---
 
-![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.png "Lenna_circle+shadow"){:.circle.shadow}
+![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.jpg "Lenna_circle+shadow"){:.circle.shadow}
 
 **markdown:**
 
     ![Lenna](path-to-image.jpg){:.circle.shadow}
 
 ---
 
-![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.png "Lenna_circle+border+shadow"){:.circle.border.shadow}
+![Lenna](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/test/assets/images/lenna.jpg "Lenna_circle+border+shadow"){:.circle.border.shadow}
 
 **markdown:**