Skip to content

Commit 9b98eb5

Browse files
committed
feat: add highlight theme in configuration docs
1 parent 7ae4ba7 commit 9b98eb5

5 files changed

+57
-11
lines changed

README-zh.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ TeXt 是针对个人或团队网站、博客、项目、文档等的一款 Jekyl
1616

1717
- 响应式
1818
- 皮肤
19+
- 代码高亮主题
1920
- 目录
2021
- 多作者
2122
- 多语言支持(English, 简体中文, 繁體中文)
@@ -36,11 +37,19 @@ TeXt 内置以下 6 套皮肤:
3637

3738
| `default` | `dark` | `forest` |
3839
| --- | --- | --- |
39-
| ![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) |
40+
| ![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) |
4041

4142
| `ocean` | `chocolate` | `orange` |
4243
| --- | --- | --- |
43-
| ![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) |
44+
| ![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) |
45+
46+
### 代码高亮主题
47+
48+
TeXt 使用 [Tomorrow](https://github.com/chriskempson/tomorrow-theme) 作为它的代码高亮主题。
49+
50+
| `tomorrow` | `tomorrow-night` | `tomorrow-night-eighties` | `tomorrow-night-blue` | `tomorrow-night-bright` |
51+
| --- | --- | --- | --- | --- |
52+
| ![Tomorrow](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow.png) | ![Tomorrow Night](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night.png) | ![Tomorrow Night Eighties](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night-eighties.png) | ![Tomorrow Night Blue](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night-blue.png) | ![Tomorrow Night Bright](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night-bright.png) |
4453

4554
## 文档
4655

README.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ TeXt is a Jekyll theme for personal site, team site, blog, project, documentatio
1616

1717
- Responsive
1818
- Skins
19+
- Highlight Theme
1920
- Table of contents
2021
- Authors
2122
- Multi-language support(English, Simplified Chinese, Traditional Chinese)
@@ -36,11 +37,19 @@ You can choose these 6 built-in skins below:
3637

3738
| `default` | `dark` | `forest` |
3839
| --- | --- | --- |
39-
| ![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) |
40+
| ![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) |
4041

4142
| `ocean` | `chocolate` | `orange` |
4243
| --- | --- | --- |
43-
| ![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) |
44+
| ![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) |
45+
46+
### Highlight Theme
47+
48+
TeXt use [Tomorrow](https://github.com/chriskempson/tomorrow-theme) as the highlight theme.
49+
50+
| `tomorrow` | `tomorrow-night` | `tomorrow-night-eighties` | `tomorrow-night-blue` | `tomorrow-night-bright` |
51+
| --- | --- | --- | --- | --- |
52+
| ![Tomorrow](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow.png) | ![Tomorrow Night](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night.png) | ![Tomorrow Night Eighties](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night-eighties.png) | ![Tomorrow Night Blue](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night-blue.png) | ![Tomorrow Night Bright](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night-bright.png) |
4453

4554
## Documentation
4655

docs/en/1.7-update-form-1-to-2.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ key: docs-update-form-1-to-2
66

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

9-
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.
9+
After several months effort, **TeXt 2** has finally released. the new version has lots of refactors and changes, which leads to some configuration incompatibilities. Hope this document will help you with your upgrade.
1010

1111
## Skin
1212

@@ -111,15 +111,15 @@ paths:
111111

112112
## License
113113

114-
You need to specify `license` in *_config.yml* to enable license, witch default to `false`:
114+
You need to specify `license` in *_config.yml* to enable license, which default to `false`:
115115

116116
```yml
117117
license: CC-BY-4.0
118118
```
119119

120120
## Comments
121121

122-
There are some changes for configuration of comments, pageview and analytics in TeXt 2. witch mainly add a `provider` attribute and change providers into corresponding sub-configuration items.
122+
There are some changes for configuration of comments, pageview and analytics in TeXt 2. which mainly add a `provider` attribute and change providers into corresponding sub-configuration items.
123123

124124
1.x:
125125

docs/en/2.1-configuration.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,30 @@ You can choose these 6 built-in skins below:
2727
2828
| `default` | `dark` | `forest` |
2929
| --- | --- | --- |
30-
| ![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) |
30+
| ![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) |
3131

3232
| `ocean` | `chocolate` | `orange` |
3333
| --- | --- | --- |
34-
| ![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) |
34+
| ![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) |
3535

3636
```yaml
3737
text_skin: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
3838
```
3939

40+
### Highlight Theme
41+
42+
TeXt use [Tomorrow](https://github.com/chriskempson/tomorrow-theme) as the highlight theme.
43+
44+
| `tomorrow` | `tomorrow-night` | `tomorrow-night-eighties` | `tomorrow-night-blue` | `tomorrow-night-bright` |
45+
| --- | --- | --- | --- | --- |
46+
| ![Tomorrow](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow.png) | ![Tomorrow Night](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night.png) | ![Tomorrow Night Eighties](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night-eighties.png) | ![Tomorrow Night Blue](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night-blue.png) | ![Tomorrow Night Bright](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night-bright.png) |
47+
48+
Every skin has a default highlight theme, but you can overwrite it by `highlight_theme` variable.
49+
50+
```yaml
51+
highlight_theme: default # "default" (default), "tomorrow", "tomorrow-night", "tomorrow-night-eighties", "tomorrow-night-blue", "tomorrow-night-bright"
52+
```
53+
4054
### URL
4155

4256
The base hostname and protocol for your site. if you are hosting the site on Github Pages this will be set as the GitHub Pages domain (cname or user domain)[^gitHub_metadata]. For example, https://kitian616.github.io or https://tianqi.name if there is cname file.

docs/zh/2.1-configuration.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,30 @@ TeXt 内置以下 6 套皮肤:
2727
2828
| `default` | `dark` | `forest` |
2929
| --- | --- | --- |
30-
| ![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) |
30+
| ![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) |
3131

3232
| `ocean` | `chocolate` | `orange` |
3333
| --- | --- | --- |
34-
| ![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) |
34+
| ![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) |
3535

3636
```yaml
3737
text_skin: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
3838
```
3939

40+
### 代码高亮主题
41+
42+
TeXt 使用 [Tomorrow](https://github.com/chriskempson/tomorrow-theme) 作为它的代码高亮主题。
43+
44+
| `tomorrow` | `tomorrow-night` | `tomorrow-night-eighties` | `tomorrow-night-blue` | `tomorrow-night-bright` |
45+
| --- | --- | --- | --- | --- |
46+
| ![Tomorrow](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow.png) | ![Tomorrow Night](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night.png) | ![Tomorrow Night Eighties](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night-eighties.png) | ![Tomorrow Night Blue](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night-blue.png) | ![Tomorrow Night Bright](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/highlight_tomorrow-night-bright.png) |
47+
48+
每个皮肤有一个默认的代码高亮主题,当然你可以通过 `highlight_theme` 配置项来指定其他主题。
49+
50+
```yaml
51+
highlight_theme: default # "default" (default), "tomorrow", "tomorrow-night", "tomorrow-night-eighties", "tomorrow-night-blue", "tomorrow-night-bright"
52+
```
53+
4054
### URL
4155

4256
网站的协议和域名。

0 commit comments

Comments
 (0)