Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
kitian616 committed Oct 6, 2019
1 parent 9b77b1f commit f98ca43
Show file tree
Hide file tree
Showing 31 changed files with 45 additions and 39 deletions.
8 changes: 4 additions & 4 deletions docs/_docs/en/1.1-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ In this document, you will learn how to **install the theme**, **setup your site

```mermaid
graph LR;
A0[Installing TeXt]
B0[Common Method]
A0(Installing TeXt)
B0(Common Method)
B1[Ruby Gem Method]
C0[Fork this repo]
C1[Clone from GitHub]
C2[Download]
D0[Setup Your Site]
E0[Installing Development Environment]
E0(Installing Development Environment)
F0[Installing Directly]
F1[Docker]
A0-->B0;
Expand Down Expand Up @@ -140,4 +140,4 @@ For Docker, run `docker-compose -f ./docker/docker-compose.default.yml up` to st

If you host your site on GitHub Pages, just push the source to the master branch of your USERNAME.github.io repository, GitHub would build automatically. You can visit your site on **https://USERNAME.github.io** several minutes later.

If you host your site on your server, you need first run `JEKYLL_ENV=production bundle exec jekyll build` to generated your site, then update the files in *_site* folder to your server.
If you host your site on your server, you need first run `JEKYLL_ENV=production bundle exec jekyll build` to generated your site, then update the files in *_site* folder to your server.
2 changes: 1 addition & 1 deletion docs/_docs/en/1.2-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ key: docs-structure
├── index.html
├── jekyll-text-theme.gemspec
└── package.json
```
```
2 changes: 1 addition & 1 deletion docs/_docs/en/1.7-update-from-1-to-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,4 +212,4 @@ header:
zh-Hans: 关于
zh-Hant: 關於
url: /blog/about.html
```
```
2 changes: 1 addition & 1 deletion docs/_docs/en/2.1-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -362,4 +362,4 @@ analytics:
google:
tracking_id: "your-google-analytics-tracking-code"
anonymize_ip: true
```
```
2 changes: 1 addition & 1 deletion docs/_docs/en/2.3-layouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,4 +175,4 @@ Base on Page Layout.

## 404 Layout

Base on Page Layout.
Base on Page Layout.
2 changes: 1 addition & 1 deletion docs/_docs/en/2.5-authors.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ Assign one of the authors in *authors.yml* to a post or page you wish to overrid

---
author: Tian Qi
---
---
7 changes: 5 additions & 2 deletions docs/_docs/en/2.7-i18n.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,16 @@ By using `titles`, you can define multi-language name for page, layout and navig

<!-- more -->

The translation keys and multi-language names mentioned above support the following languages.
The translation keys and multi-language names mentioned above support the following languages:
<!-- @start locale config -->

| Language | `lang` |
| --- | --- |
| **English** | en, en-GB, en-US, en-CA, en-AU |
| **Simplified Chinese** | zh-Hans, zh, zh-CN, zh-SG |
| **Traditional Chinese** | zh-Hant, zh-TW, zh-HK |
| **Korean** | ko, ko-KR |
| **French** | fr, fr-BE, fr-CA, fr-CH, fr-FR, fr-LU |

You can see examples for different languages [HERE](https://tianqi.name/jekyll-TeXt-theme/samples.html#languages).
<!-- @end locale config -->
You can see examples for different languages [HERE](https://tianqi.name/jekyll-TeXt-theme/samples.html#languages).
2 changes: 1 addition & 1 deletion docs/_docs/en/3.1-writing-posts.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ To improve the user experience for both reading and writing posts, TeXt made som

Between these triple-dashed lines you can set variables. you can consider it as page configuration, these would overrides the global configuration in *_config.yml*.

Beside Jekyll’s predefined variables, TeXt define some new variables for each layouts, see [Layouts](https://tianqi.name/jekyll-TeXt-theme/docs/en/layouts) for details.
Beside Jekyll’s predefined variables, TeXt define some new variables for each layouts, see [Layouts](https://tianqi.name/jekyll-TeXt-theme/docs/en/layouts) for details.
2 changes: 1 addition & 1 deletion docs/_docs/en/3.2-markdown-enhancements.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,4 +168,4 @@ graph TB;

- [Doughnut Chart](http://www.chartjs.org/docs/latest/charts/doughnut.html)

- [Bubble Chart](http://www.chartjs.org/docs/latest/charts/bubble.html)
- [Bubble Chart](http://www.chartjs.org/docs/latest/charts/bubble.html)
2 changes: 1 addition & 1 deletion docs/_docs/en/3.3-additional-styles.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,4 +166,4 @@ Error Text.
![Image](path-to-image){:.circle.border.shadow}
</div>
</div>
</div>
</div>
2 changes: 1 addition & 1 deletion docs/_docs/en/3.4-extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,4 +171,4 @@ Available in Chinese mainland.
```
<div>{%- include extensions/codepen.html user='kitian616' hash='aQmWZG' default_tab='html,result' -%}</div>
```
{% endraw %}
{% endraw %}
2 changes: 1 addition & 1 deletion docs/_docs/en/4.1-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ Where *spacer* is one of:
```html
<div class="p-4"></div>
<div class="padding: ($spacer * 1.5);"></div>
```
```
2 changes: 1 addition & 1 deletion docs/_docs/en/4.2-grid.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,4 +206,4 @@ key: docs-grid
<div class="content">loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong</div>
</div>
</div>
</div>
</div>
2 changes: 1 addition & 1 deletion docs/_docs/en/4.3-icons.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ TeXt uses Font Awesome for icons, you can search available icon code snippet [HE

```html
<a class="button button--success button--rounded button--lg" href="#"><i class="fas fa-download"></i> Download TeXt Theme</a>
```
```
2 changes: 1 addition & 1 deletion docs/_docs/en/4.4-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ key: docs-image

```html
<img class="image image--xl" src=""/>
```
```
2 changes: 1 addition & 1 deletion docs/_docs/en/4.5-button.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,4 +135,4 @@ key: docs-button

```html
<a class="button button--primary button--rounded button--xl" href="">BUTTON</a>
```
```
2 changes: 1 addition & 1 deletion docs/_docs/en/4.6-item.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,4 +179,4 @@ key: docs-item
</div>
</div>
</div>
```
```
2 changes: 1 addition & 1 deletion docs/_docs/en/4.7-card.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,4 +182,4 @@ key: docs-card
</div>
</div>
</a>
```
```
2 changes: 1 addition & 1 deletion docs/_docs/en/4.8-hero.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,4 +165,4 @@ key: docs-hero
<p>...</p>
</div>
</div>
```
```
2 changes: 1 addition & 1 deletion docs/_docs/en/4.9-swiper.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,4 +158,4 @@ window.Lazyload.js(SOURCES.jquery, function() {
$('.swiper-demo--3').swiper();
$('.swiper-demo--4').swiper({ animation: false });
});
</script>
</script>
8 changes: 4 additions & 4 deletions docs/_docs/zh/1.1-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ TeXt 是一款 100% 兼容 GitHub Pages 的 Jekyll 主题,你可以通过 Fork

```mermaid
graph LR;
A0[安装 TeXt]
B0[普通方式]
A0(安装 TeXt)
B0(普通方式)
B1[主题方式]
C0[从 GitHub 克隆]
C1[Fork 该仓库]
C2[下载]
D0[设置]
E0[安装开发环境]
E0(安装开发环境)
F0[直接安装]
F1[使用 Docker]
A0-->B0;
Expand Down Expand Up @@ -142,4 +142,4 @@ Jekyll 集成了一个开发用的服务器,可以让你使用浏览器在本

如果你打算把网站搭建在 GitHub Pages 上,那你所需要做的就是将项目的源码上传到 USERNAME.github.io 源码仓库的 master 分支,GitHub 会自动的编译,几分钟后你就可以通过 **https://USERNAME.github.io** 访问到你的网站了。

如果你的网站是搭建在其他服务器上的,那么你就需要来自己编译了。首先运行命令 `JEKYLL_ENV=production bundle exec jekyll build` 编译你的网站,然后将编译的文件(位于 *_site* 目录)更新到你的服务器上。
如果你的网站是搭建在其他服务器上的,那么你就需要来自己编译了。首先运行命令 `JEKYLL_ENV=production bundle exec jekyll build` 编译你的网站,然后将编译的文件(位于 *_site* 目录)更新到你的服务器上。
2 changes: 1 addition & 1 deletion docs/_docs/zh/1.7-update-from-1-to-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,4 +212,4 @@ header:
zh-Hans: 关于
zh-Hant: 關於
url: /blog/about.html
```
```
2 changes: 1 addition & 1 deletion docs/_docs/zh/2.2-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ docs-en:
```yaml
sidebar:
nav: docs-en
```
```
2 changes: 1 addition & 1 deletion docs/_docs/zh/2.3-layouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,4 +173,4 @@ articles:

## 404 布局

继承于 Page 布局。
继承于 Page 布局。
2 changes: 1 addition & 1 deletion docs/_docs/zh/2.4-logo-and-favicon.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ TeXt 推荐使用 [RealFaviconGenerator](https://realfavicongenerator.net/) 来

![Result](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/realfavicongenerator-result.jpg)

下载生成的 favicon 包,解压文件到你方才填写的路径,将 HTML 代码替换到 *_includes/head/favicon.html* 文件中。
下载生成的 favicon 包,解压文件到你方才填写的路径,将 HTML 代码替换到 *_includes/head/favicon.html* 文件中。
2 changes: 1 addition & 1 deletion docs/_docs/zh/2.5-authors.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ Tian Qi:

---
author: Tian Qi
---
---
7 changes: 5 additions & 2 deletions docs/_docs/zh/2.7-i18n.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,16 @@ TeXt 把 UI 元素的文字整理成一系列的翻译标识统一的放置在 *

<!-- more -->

上文所提到的翻译标识和多语言标题支持以下语言。
上文所提到的翻译标识和多语言标题支持以下语言:
<!-- @start locale config -->

| 语言 | `lang` |
| --- | --- |
| **英语** | en, en-GB, en-US, en-CA, en-AU |
| **简体中文** | zh-Hans, zh, zh-CN, zh-SG |
| **繁体中文** | zh-Hant, zh-TW, zh-HK |
| **韩语** | ko, ko-KR |
| **法语** | fr, fr-BE, fr-CA, fr-CH, fr-FR, fr-LU |

你可以在 [这里](https://tianqi.name/jekyll-TeXt-theme/samples.html#languages) 找到不同语言的示例。
<!-- @end locale config -->
你可以在 [这里](https://tianqi.name/jekyll-TeXt-theme/samples.html#languages) 找到不同语言的示例。
2 changes: 1 addition & 1 deletion docs/_docs/zh/3.1-writing-posts.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ key: docs-writing-posts-zh

`---` 之间你可以设置属性的值,可以把它们看作页面的配置,这些配置会覆盖在 *_config.yml* 文件中设置的全局配置。

除去 Jekyll 自定义的变量外,TeXt 也定义了一些额外的变量,详情请戳[布局](https://tianqi.name/jekyll-TeXt-theme/docs/zh/layouts)
除去 Jekyll 自定义的变量外,TeXt 也定义了一些额外的变量,详情请戳[布局](https://tianqi.name/jekyll-TeXt-theme/docs/zh/layouts)
2 changes: 1 addition & 1 deletion docs/_docs/zh/3.2-markdown-enhancements.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,4 +168,4 @@ graph TB;

- [Doughnut Chart](http://www.chartjs.org/docs/latest/charts/doughnut.html)

- [Bubble Chart](http://www.chartjs.org/docs/latest/charts/bubble.html)
- [Bubble Chart](http://www.chartjs.org/docs/latest/charts/bubble.html)
2 changes: 1 addition & 1 deletion docs/_docs/zh/3.3-additional-styles.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,4 +166,4 @@ Error Text.
![Image](path-to-image){:.circle.border.shadow}
</div>
</div>
</div>
</div>
2 changes: 1 addition & 1 deletion docs/_docs/zh/3.4-extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,4 +169,4 @@ key: docs-extensions-zh
```
<div>{%- include extensions/codepen.html user='kitian616' hash='aQmWZG' default_tab='html,result' -%}</div>
```
{% endraw %}
{% endraw %}

0 comments on commit f98ca43

Please sign in to comment.