Skip to content

Commit

Permalink
feat: rename text_color_theme in _config.yml to text_skin
Browse files Browse the repository at this point in the history
  • Loading branch information
kitian616 committed Jun 30, 2018
1 parent 1cf02b7 commit 4bc9948
Show file tree
Hide file tree
Showing 32 changed files with 100 additions and 74 deletions.
2 changes: 1 addition & 1 deletion CHECKLIST.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

- _config.yml unchanged

- _sass/settings/_colors.scss use default color theme
- _sass/settings/_colors.scss use default skin
10 changes: 5 additions & 5 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,24 @@ TeXt 是针对个人网站、博客、项目、文档等等的一款 Jekyll 主
- Google Analytics
- 联系方式设置(Email, Facebook, Twitter, 微博, 知乎……)
- Web 语意化
- Color Theme
- 皮肤
- 数学公式([MathJax](https://www.mathjax.org/)
- 流程图, 序列图,甘特图([mermaid](https://mermaidjs.github.io/)
- 柱状图,折线图,饼图,雷达图([chartjs](http://www.chartjs.org/)
- RSS([jekyll-feed](https://github.com/jekyll/jekyll-feed)
- 多语言支持(English, 简体中文, 繁體中文)

## Color Theme
## 皮肤

TeXt 内置以下 6 套颜色主题
TeXt 内置以下 6 套皮肤

| `default` | `dark` | `forest` |
| --- | --- | --- |
| ![default](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_default.png) | ![dark](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_dark.png) | ![forest](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_forest.png) |
| ![default](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_default.png) | ![dark](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_dark.png) | ![forest](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_forest.png) |

| `ocean` | `chocolate` | `orange` |
| --- | --- | --- |
| ![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) |
| ![ocean](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_ocean.png) | ![chocolate](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_chocolate.png) | ![orange](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_orange.png) |

## 文档

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,24 @@ TeXt is a Jekyll theme for personal site, blog, project, documentation and so on
- Google Analytics
- Contact information (Email, Facebook, Twitter, Linkedin, Weibo, Zhihu, etc)
- Semantic HTML
- Color Theme
- Skins
- Mathematical formula ([MathJax](https://www.mathjax.org/))
- Flowchart, Sequence diagram, Gantt diagram ([mermaid](https://mermaidjs.github.io/))
- Line Chart, Bar Chart, Radar Chart, Pie Chart ([chartjs](http://www.chartjs.org/))
- RSS([jekyll-feed](https://github.com/jekyll/jekyll-feed))
- Multi-language support(English, Simplified Chinese, Traditional Chinese)

## Color Themes
## Skins

You can choose these 6 built-in color themes below:
You can choose these 6 built-in skins below:

| `default` | `dark` | `forest` |
| --- | --- | --- |
| ![default](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_default.png) | ![dark](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_dark.png) | ![forest](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_forest.png) |
| ![default](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_default.png) | ![dark](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_dark.png) | ![forest](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_forest.png) |

| `ocean` | `chocolate` | `orange` |
| --- | --- | --- |
| ![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) |
| ![ocean](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_ocean.png) | ![chocolate](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_chocolate.png) | ![orange](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_orange.png) |

## Documentation

Expand Down
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

## => Site Settings
##############################
text_color_theme: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
text_skin: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
url : # the base hostname & protocol for your site e.g. https://www.someone.com
baseurl : # does not include hostname
title : Someone's blog
Expand Down
3 changes: 2 additions & 1 deletion _data/variables.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
default:
text_color_theme: default
text_skin: default
lang: en
paths:
root: /
Expand All @@ -16,6 +16,7 @@ default:
excerpt_type: text

page:
type: webpage
show_header: true
show_title: true
show_edit_on_github: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
///
// Color Theme: Chocolate
// Skin: Chocolate
// Author: Tian Qi
// Email: kitian616@outlook.com
///
Expand Down
2 changes: 1 addition & 1 deletion _sass/colors/_dark.scss → _sass/skins/_dark.scss
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
///
// Color Theme: Dark
// Skin: Dark
// Author: Tian Qi
// Email: kitian616@outlook.com
///
Expand Down
2 changes: 1 addition & 1 deletion _sass/colors/_default.scss → _sass/skins/_default.scss
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
///
// Color Theme: Default
// Skin: Default
// Author: Tian Qi
// Email: kitian616@outlook.com
///
Expand Down
2 changes: 1 addition & 1 deletion _sass/colors/_forest.scss → _sass/skins/_forest.scss
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
///
// Color Theme: Forest
// Skin: Forest
// Author: Tian Qi
// Email: kitian616@outlook.com
///
Expand Down
2 changes: 1 addition & 1 deletion _sass/colors/_ocean.scss → _sass/skins/_ocean.scss
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
///
// Color Theme: Ocean
// Skin: Ocean
// Author: Tian Qi
// Email: kitian616@outlook.com
///
Expand Down
2 changes: 1 addition & 1 deletion _sass/colors/_orange.scss → _sass/skins/_orange.scss
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
///
// Color Theme: Orange
// Skin: Orange
// Author: Tian Qi
// Email: kitian616@outlook.com
///
Expand Down
10 changes: 5 additions & 5 deletions about.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,21 @@ TeXt is succinct Jekyll theme, Perfect for hosting your personal site, blog, doc
- 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
- Skins
- Mathematical formula ([MathJax](https://www.mathjax.org/))
- Flowchart, Sequence diagram, Gantt diagram ([mermaid](https://mermaidjs.github.io/))
- Line Chart, Bar Chart, Radar Chart, Pie Chart ([chartjs](http://www.chartjs.org/))
- RSS([jekyll-feed](https://github.com/jekyll/jekyll-feed))
- Multi-language support(English, Simplified Chinese, Traditional Chinese)

## Color Themes
## Skins

You can choose these 6 built-in color themes below:
You can choose these 6 built-in Skins below:

| `default` | `dark` | `forest` |
| --- | --- | --- |
| ![default](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_default.png) | ![dark](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_dark.png) | ![forest](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_forest.png) |
| ![default](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_default.png) | ![dark](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_dark.png) | ![forest](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_forest.png) |

| `ocean` | `chocolate` | `orange` |
| --- | --- | --- |
| ![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) |
| ![ocean](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_ocean.png) | ![chocolate](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_chocolate.png) | ![orange](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_orange.png) |
14 changes: 7 additions & 7 deletions assets/css/main.scss
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
@charset "utf-8";

@import
"colors/{{ site.text_color_theme | default: site.data.variables.default.text_color_theme }}",
// "colors/chocolate",
// "colors/dark",
// "colors/default",
// "colors/forest",
// "colors/ocean",
// "colors/orange",
"skins/{{ site.text_skin | default: site.data.variables.default.text_skin }}",
// "skins/chocolate",
// "skins/dark",
// "skins/default",
// "skins/forest",
// "skins/ocean",
// "skins/orange",

"common/variables",
"common/highlighting",
Expand Down
2 changes: 1 addition & 1 deletion docs/_config.dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

## => Site Settings
##############################
text_color_theme: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
text_skin: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
url : # the base hostname & protocol for your site e.g. https://www.someone.com
baseurl : # does not include hostname
title : TeXt Dev
Expand Down
2 changes: 1 addition & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

## => Site Settings
##############################
text_color_theme: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
text_skin: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
url : https://tianqi.name
baseurl : /jekyll-TeXt-theme
title : TeXt Theme
Expand Down
4 changes: 2 additions & 2 deletions docs/_data/variables.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
default:
text_color_theme: default
text_skin: default
lang: en
paths:
root: /
Expand All @@ -16,7 +16,7 @@ default:
excerpt_type: text

page:
type: 'webpage'
type: webpage
show_header: true
show_title: true
show_edit_on_github: false
Expand Down
19 changes: 18 additions & 1 deletion docs/en/1.7-update-form-1-to-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,24 @@ permalink: /docs/en/update-form-1-to-2
key: docs-update-form-1-to-2
---

![TeXt 2](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/TeXt-version-2.png)

After several months effort, **TeXt 2** has finally released. the new version has lots of refactors and changes, witch leads to some configuration incompatibility. Hope this document will help you with your upgrade.

## Skin

`text_color_theme` in *_config.yml* rename to `text_skin`.

1.x:

```yml
text_color_theme: forest
```
```yml
text_skin: forest
```
## Layout
### Article Layout
Expand Down Expand Up @@ -72,7 +88,7 @@ layout: archive
## Paths
In order to maintain consistency with the layout naming, TeXt 2 renamed `all.html` to `archive.html`. `base` and `all` variables under `paths` in *_config.yml* has renamed to `root` and `archive`.
In order to maintain consistency with the layout naming, TeXt 2 renamed *all.html* to *archive.html*. `base` and `all` variables under `paths` in *_config.yml* has renamed to `root` and `archive`.

1.x:

Expand All @@ -88,6 +104,7 @@ paths:
```yml
paths:
root : /blog
home : /blog
archive : /blog/archive.html
rss : /feed.xml
```
Expand Down
10 changes: 5 additions & 5 deletions docs/en/2.1-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,20 @@ If you’re using the Ruby gem version of the theme you’ll need this line to a
theme: jekyll-text-theme
```
### Color Theme
### Skin
You can choose these 6 built-in color themes below:
You can choose these 6 built-in skins below:
| `default` | `dark` | `forest` |
| --- | --- | --- |
| ![default](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_default.png) | ![dark](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_dark.png) | ![forest](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_forest.png) |
| ![default](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_default.png) | ![dark](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_dark.png) | ![forest](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_forest.png) |

| `ocean` | `chocolate` | `orange` |
| --- | --- | --- |
| ![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) |
| ![ocean](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_ocean.png) | ![chocolate](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_chocolate.png) | ![orange](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_orange.png) |

```yaml
text_color_theme: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
text_skin: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
```

### URL
Expand Down
32 changes: 19 additions & 13 deletions docs/zh/1.7-update-form-1-to-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,24 @@ permalink: /docs/zh/update-form-1-to-2
key: docs-update-form-1-to-2-zh
---

![TeXt 2](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/TeXt-version-2.png)

经过几个月的努力,**TeXt 2** 终于发布了,第二版在第一版的基础上做了大量的重构与更改,这也导致了一些配置的不兼容。希望这篇文档能对你的升级起到一些帮助,感谢你们的支持。

## 皮肤

*_config.yml*`text_color_theme` 配置项更名为 `text_skin`

1.x:

```yml
text_color_theme: forest
```
```yml
text_skin: forest
```
## Layout
### Article 布局
Expand Down Expand Up @@ -38,7 +54,7 @@ show_edit_on_github: true
pageview: true
```
你也可以在 _config.yml 中设置 posts 类型的[默认值](https://jekyllrb.com/docs/configuration/#front-matter-defaults):
你也可以在 *_config.yml* 中设置 posts 类型的[默认值](https://jekyllrb.com/docs/configuration/#front-matter-defaults):
```yml
defaults:
Expand Down Expand Up @@ -70,20 +86,9 @@ layout: all
layout: archive
```
为了保持和布局命名的一致性,新版将原有的 `all.html` 更名为 `archive.html`,这在一些默认配置中也做了相应的修改:

```yml
paths:
base: /blog
archive: /blog/archive.html
rss: /feed.xml
```

请留意关于”all“的报错,并将其修改为“archive”。

## Paths
为了保持和布局命名的一致性,新版将原有的 `all.html` 更名为 `archive.html`。*_config.yml* 中 `paths` 的配置项 `base` 和 `all` 分别更名为 `root` 和 `archive`。
为了保持和布局命名的一致性,新版将原有的 *all.html* 更名为 *archive.html*。*_config.yml* 中 `paths` 的配置项 `base` 和 `all` 分别更名为 `root` 和 `archive`。

1.x:

Expand All @@ -99,6 +104,7 @@ paths:
```yml
paths:
root : /blog
home : /blog
archive : /blog/archive.html
rss : /feed.xml
```
Expand Down
10 changes: 5 additions & 5 deletions docs/zh/2.1-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,20 @@ Jekyll 允许你很轻松的设计你的网站,这很大程度上归功于灵
theme: jekyll-text-theme
```
### 颜色主题
### 皮肤
TeXt 内置了以下 6 中颜色主题
TeXt 内置以下 6 套皮肤
| `default` | `dark` | `forest` |
| --- | --- | --- |
| ![default](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_default.png) | ![dark](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_dark.png) | ![forest](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/colors_forest.png) |
| ![default](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_default.png) | ![dark](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_dark.png) | ![forest](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_forest.png) |

| `ocean` | `chocolate` | `orange` |
| --- | --- | --- |
| ![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) |
| ![ocean](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_ocean.png) | ![chocolate](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_chocolate.png) | ![orange](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_orange.png) |

```yaml
text_color_theme: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
text_skin: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
```

### URL
Expand Down
Binary file added screenshots/TeXt-version-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshots/TeXt.sketch
Binary file not shown.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion test/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ theme: jekyll-text-theme

## => Site Settings
##############################
text_color_theme: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
text_skin: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
url : # the base hostname & protocol for your site e.g. https://www.someone.com
baseurl : # does not include hostname
title : Someone's blog
Expand Down
Loading

0 comments on commit 4bc9948

Please sign in to comment.