Compare commits

...

No commits in common. "4e2177476bb85d9f27a8ee0f760de05ff6294fe7" and "293f050d154f6d508003850503a5a87983d07379" have entirely different histories.

249 changed files with 547 additions and 9494 deletions

5
.markdownlint.json Normal file
View File

@ -0,0 +1,5 @@
{
"MD033": false,
"MD013": false,
"MD041": false
}

View File

@ -1,235 +0,0 @@
# Change Log
## 2.2.6 (2019-02-02)
### Enhancements
- Add [commit linter](https://commitlint.js.org/)
- Add [EditorConfig](https://editorconfig.org/)
- Update npm packages
### Bug Fixes
- Fix some spelling errors in documents
- Fix some errors in configs
## 2.2.5 (2019-12-08)
### Enhancements
- Update to Jekyll 4.0
- Add custom snippets for main/top, main/bottom, article/top, article/bottom, etc
- Add Medium, Zhihu social icons
- Add Google Custom Search support
- Add Korean locale (@ssosso)
- Add French locale (@ctrl-q)
- Add Docker support
## 2.2.4 (2018-12-10)
### Enhancements
- Swiper component support mouse move
- Add lightbox (modal image gallery)
- Add Valine comment system (@Lloyar)
### Bug Fixes
- Fix some spelling errors in documents (@Krinkle)
## 2.2.3 (2018-11-11)
### Enhancements
- Add Swiper component
- Add AddThis sharing service (@liao961120)
- Add extensions for demos (CodePen)
- Add special stylesheets for print
## 2.2.2 (2018-10-21)
### Enhancements
- Add extensions for audios (SoundCloud, Netease Cloud Music), videos (YouTube, TED, bilibili) and slide(SlideShare)
- Add AddToAny sharing service
## 2.2.1 (2018-10-02)
### Enhancements
- Update screenshots
- Landing layout `data.sections` item's `image` add `full_width` setting
- Remove `header.type` and add `header.background` setting
- Page layout sidebar use document scroll when viewport width < 1024px, this enhance the user experience on a phone or a pad
- Telegram social icon (@WangQiru)
- Search panel use dark background
## 2.2.0 (2018-09-16)
### Enhancements
- `article_header` setting for page layout
- Articles layout
- New grid system
- Image, card, item and hero components
- Tag additional style
- chart.js update to 2.7.2, mathjax update to 2.7.4 and mermaid update to 8.0.0-rc.8
### Bug Fixes
- Replace Lenna test image
## 2.1.0 (2018-08-26)
### Enhancements
- Search panel (Click search icon in the header or press `s` or `/` key to search)
- Npm social icon (@WangQiru)
### Bug Fixes
- Google analytics may not work, use gtag.js
## 2.0.2 (2018-07-29)
### Enhancements
- Highlight theme
- Articles whit `sidebar.toc` support section navigator (previous and next navigator)
- Aside Toc show immediately after page get ready (no more delay)
### Bug Fixes
- Aside Toc may display error when scroll to bottom
## 2.0.1 (2018-07-07)
> “All elements that respond to press should have a visual feedback when touched.”
>
> —TouchableWithoutFeedback in *React Native Docs*
### Enhancements
- Some interaction details optimize: button and link add feedback when clicked, cancel button of input in archive layout, button focus style, etc
### Bug Fixes
- `mathjax` and `mermaid` setting may not work
## 2.0.0 (2018-07-01)
Breaking changes, please check [Update from 1.x to 2.x](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/update-from-1-to-2) for details
### Enhancements
- Authors
- License
- New layouts (page, article, landing, etc)
## 1.5.0 (2018-03-18)
### Enhancements
- `text_color_theme` setting
- Long pagination
- Additional styles (Alert, Image)
- Mathjax `autoNumber` setting (@liao961120)
- Article heading anchor
- Previous and next post
- Search
## 1.4.3 (2018-01-13)
### Enhancements
- New TOC style
- Gitalk support (@WangQiru)
- Mermaid support
- `site.paths` and `site.nav_lists` configs support absolute URL
## 1.4.2 (2017-12-10)
### Enhancements
- Use new liquid syntax `{%-` `-%}` to avoid unnecessary output whitespace
- Add `paths.base` setting
## 1.4.1 (2017-12-05)
### Enhancements
- New color themes(Chocolate, Orange)
### Bug Fixes
- Issues 9: the _posts file can't recorded by git
## 1.4.0 (2017-11-19)
### Enhancements
- Internationalization
### Bug Fixes
- Table overflow-x smooth on iOS
## 1.3.0 (2017-11-11)
### Enhancements
- Article tag supports special characters
- Excerpts type (HTML | TEXT)
- Titles on the phone become smaller
- Change styles for table, code and blockquote
## 1.2.2 (2017-11-04)
### Enhancements
- MathJax Support
- Add “Read more” link at the end of article excerpt
- 404 page
### Bug Fixes
- Fix Email link URL error
- Fix Site Title link URL error
- Fix table responsive style error
## 1.2.1 (2017-10-27)
### Enhancements
- Optimize Article TOC
### Bug Fixes
- Pageview display error when the post key include `-` (@yuxianda)
- Email url error
## 1.2.0 (2017-10-22)
### Enhancements
- Article excerpt no more than 200 words
- If `leancloud` is not set, 0 view won't display
### Bug Fixes
- Fix article TOCs display error at proper situation
- Fix footer social buttons not in the center bug
## 1.1.0 (2017-10-19)
### Enhancements
- Color variables
- More color themes (dark, forest, ocean)
## 1.0.0 (2017-10-17)
### Enhancements
- Better article directories
- Dark color theme

View File

@ -1,19 +0,0 @@
# HOW TO RELEASE
## Preparation
- diff configs (*_config.yml*, *docs/_config.yml*, *docs/_config.dev.yml*, *test/_config.yml*)
- diff data dirs (*_data*, *docs/_data*, *test/_data*)
- *assets/css/main.scss* use configurable skin
- *screenshot.jpg* is the same as *screenshots/TeXt-home.jpg*
- update *CHANGELOG.md*
- update version (*jekyll-text-theme.gemspec*, *package.json*, *_includes/scripts/variables.html*)
## Publishing
- run `npm run gem-build` to build gem
- run `npm run gem-push` to publish gem to rubygems.org
- run `git add . && git commit -m "release: vx.x.x"` to make a release commit
- run `git tag vx.x.x` to add a tag
- run `git push && git push origin vx.x.x` to push
- edit release on github.com

View File

@ -1,106 +0,0 @@
# [TeXt Theme](https://github.com/kitian616/jekyll-TeXt-theme)
[![license](https://img.shields.io/github/license/kitian616/jekyll-TeXt-theme.svg)](https://github.com/kitian616/jekyll-TeXt-theme/blob/master/LICENSE)
[![Gem Version](https://img.shields.io/gem/v/jekyll-text-theme.svg)](https://github.com/kitian616/jekyll-TeXt-theme/releases)
[![Travis](https://img.shields.io/travis/kitian616/jekyll-TeXt-theme.svg)](https://travis-ci.org/kitian616/jekyll-TeXt-theme)
[![Tip Me via PayPal](https://img.shields.io/badge/PayPal-tip%20me-1462ab.svg?logo=paypal)](https://www.paypal.me/kitian616)
[![Tip Me via Bitcoin](https://img.shields.io/badge/Bitcoin-tip%20me-f7931a.svg?logo=bitcoin)](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/3Fkufxcw2xd8HnaRJBNK4ccdtkUDyyNu4V.jpg)
![TeXt Theme](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/TeXt-home.jpg)
![TeXt Theme Details](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/TeXt-layouts.png)
TeXt 是针对个人或团队网站、博客、项目、文档等的一款高度可定制的 Jekyll 主题。它参考了 iOS 11 的风格,有大而突出的标题和圆润的按钮及卡片。
**[English](https://github.com/kitian616/jekyll-TeXt-theme/blob/master/README.md)**
## 特性
- 响应式
- HTML 语意化
- 皮肤
- 代码高亮主题
- 国际化
- 搜索
- 目录
- 作者(支持多个)
- 附加样式(提示,标签,图片,图标,按钮,栅格等)
- 扩展(音频,视频,幻灯片,在线示例)
- Markdown 增强([MathJax](https://www.mathjax.org/)[mermaid](https://mermaidjs.github.io/)[chartjs](http://www.chartjs.org/)
- 分享([AddToAny](https://www.addtoany.com/)[AddThis](https://www.addthis.com/)
- 评论([Disqus](https://disqus.com/)[Gitalk](https://gitalk.github.io/)[Valine](https://valine.js.org/en/)
- 阅读量统计([LeanCloud](https://leancloud.cn/)
- 站点统计([Google Analytics](https://analytics.google.com/analytics/web/)
- RSS[jekyll-feed](https://github.com/jekyll/jekyll-feed)
## 皮肤
TeXt 内置有 6 套皮肤,你也可以定制自己的皮肤。
| `default` | `dark` | `forest` |
| --- | --- | --- |
| ![Default](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_default.jpg) | ![Dark](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_dark.jpg) | ![Forest](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_forest.jpg) |
| `ocean` | `chocolate` | `orange` |
| --- | --- | --- |
| ![Ocean](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_ocean.jpg) | ![Chocolate](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_chocolate.jpg) | ![Orange](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_orange.jpg) |
### 代码高亮主题
TeXt 使用 [Tomorrow](https://github.com/chriskempson/tomorrow-theme) 作为它的代码高亮主题。
| `tomorrow` | `tomorrow-night` | `tomorrow-night-eighties` | `tomorrow-night-blue` | `tomorrow-night-bright` |
| --- | --- | --- | --- | --- |
| ![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) |
## 文档
### 开始
- [快速开始](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/quick-start)
- [从 1.x 升级到 2.x](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/update-from-1-to-2)
### 定制
- [配置](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/configuration)
- [导航栏](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/navigation)
- [布局](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/layouts)
- [Logo 和 Favicon](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/logo-and-favicon)
- [作者](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/authors)
- [国际化](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/i18n)
### 内容
- [撰写博客](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/writing-posts)
- [附加样式](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/additional-styles)
- [扩展](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/extensions)
- [Markdown 增强](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/markdown-enhancements)
## 示例
| Name | Description |
| --- | --- |
| [Home](https://kitian616.github.io/jekyll-TeXt-theme/test/) | 列表页 |
| [Archive](https://kitian616.github.io/jekyll-TeXt-theme/archive.html) | 归档页 |
| [Layout Examples](https://kitian616.github.io/jekyll-TeXt-theme/samples.html) | 各种布局示例 |
## 支持我
你的支持是我的动力。你可以通过以下方式支持我:
- 给该项目点赞 🌟
- 赞同[这个知乎回答](https://www.zhihu.com/question/20223939/answer/122596506)
- 关注我的 GitHub
- 打赏
| 微信支付 | 支付宝 |
| --- | --- |
| ![微信支付二维码](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/tip_wechat.jpg) | ![支付宝二维码](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/tip_alipay.jpg) |
## 其他资源
*_includes/icon/social* 目录下有很多的社交产品图标,例如 Behance、Flickr、QQ、微信等方便修改和使用。
## 协议
TeXt Theme 遵循 [MIT 协议](https://github.com/kitian616/jekyll-TeXt-theme/blob/master/LICENSE)。

View File

@ -1,89 +1,9 @@
# [TeXt Theme](https://github.com/kitian616/jekyll-TeXt-theme)
## 说明
[![license](https://img.shields.io/github/license/kitian616/jekyll-TeXt-theme.svg)](https://github.com/kitian616/jekyll-TeXt-theme/blob/master/LICENSE)
[![Gem Version](https://img.shields.io/gem/v/jekyll-text-theme.svg)](https://github.com/kitian616/jekyll-TeXt-theme/releases)
[![Travis](https://img.shields.io/travis/kitian616/jekyll-TeXt-theme.svg)](https://travis-ci.org/kitian616/jekyll-TeXt-theme)
[![Tip Me via PayPal](https://img.shields.io/badge/PayPal-tip%20me-1462ab.svg?logo=paypal)](https://www.paypal.me/kitian616)
[![Tip Me via Bitcoin](https://img.shields.io/badge/Bitcoin-tip%20me-f7931a.svg?logo=bitcoin)](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/3Fkufxcw2xd8HnaRJBNK4ccdtkUDyyNu4V.jpg)
该分支存放`WingHexExplorer2`对应的网站资源,用于宣传、发布开发日志和引导、提供帮助文档。
![TeXt Theme](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/TeXt-home.jpg)
如果你有意愿来撰写文档或者本土化翻译,欢迎参与!!!
![TeXt Theme Details](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/TeXt-layouts.png)
If you are willing to write documents or localize translations, welcome to participate!!!
TeXt is a super customizable Jekyll theme for personal site, team site, blog, project, documentation, etc. Similar to iOS 11 style, it has large and prominent titles, round buttons and cards.
**[Change Log](https://github.com/kitian616/jekyll-TeXt-theme/blob/master/CHANGELOG.md)** | **[中文](https://github.com/kitian616/jekyll-TeXt-theme/blob/master/README-zh.md)**
## Features
- Responsive
- Semantic HTML
- Skins
- Highlight Theme
- Internationalization
- Search
- Table of contents
- Authors
- Additional styles (alert, tag, image, icon, button, grid, etc)
- Extensions (audios, videos, slides, demos)
- Markdown enhancements ([MathJax](https://www.mathjax.org/), [mermaid](https://mermaidjs.github.io/), [chartjs](http://www.chartjs.org/))
- Sharing ([AddToAny](https://www.addtoany.com/), [AddThis](https://www.addthis.com/))
- Comments ([Disqus](https://disqus.com/), [Gitalk](https://gitalk.github.io/), [Valine](https://valine.js.org/en/))
- Pageview ([LeanCloud](https://leancloud.cn/))
- Analytics ([Google Analytics](https://analytics.google.com/analytics/web/))
- RSS ([jekyll-feed](https://github.com/jekyll/jekyll-feed))
## Skins
TeXt has 6 built-in skins, you can also set up your own skin.
| `default` | `dark` | `forest` |
| --- | --- | --- |
| ![Default](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_default.jpg) | ![Dark](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_dark.jpg) | ![Forest](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_forest.jpg) |
| `ocean` | `chocolate` | `orange` |
| --- | --- | --- |
| ![Ocean](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_ocean.jpg) | ![Chocolate](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_chocolate.jpg) | ![Orange](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_orange.jpg) |
### Highlight Theme
TeXt use [Tomorrow](https://github.com/chriskempson/tomorrow-theme) as the highlight theme.
| `tomorrow` | `tomorrow-night` | `tomorrow-night-eighties` | `tomorrow-night-blue` | `tomorrow-night-bright` |
| --- | --- | --- | --- | --- |
| ![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) |
## Documentation
### Start
- [Quick Start](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/quick-start)
- [Update from 1.x to 2.x](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/update-from-1-to-2)
### Customization
- [Configuration](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/configuration)
- [Navigation](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/navigation)
- [Layouts](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/layouts)
- [Logo and Favicon](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/logo-and-favicon)
- [Authors](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/authors)
- [Internationalization](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/i18n)
### Content
- [Writing Posts](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/writing-posts)
- [Additional styles](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/additional-styles)
- [Extensions](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/extensions)
- [Markdown Enhancements](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/markdown-enhancements)
## Demo Pages
| Name | Description |
| --- | --- |
| [Home](https://kitian616.github.io/jekyll-TeXt-theme/test/) | Home page |
| [Archive](https://kitian616.github.io/jekyll-TeXt-theme/archive.html) | Archive page |
| [Layout Examples](https://kitian616.github.io/jekyll-TeXt-theme/samples.html) | Examples for different layouts |
## License
TeXt Theme is [MIT licensed](https://github.com/kitian616/jekyll-TeXt-theme/blob/master/LICENSE).
TODO软件使用效果图、文档以及原开发日志的迁移。

View File

@ -18,16 +18,16 @@
##############################
text_skin: dark # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
highlight_theme: tomorrow-night-eighties # "default" (default), "tomorrow", "tomorrow-night", "tomorrow-night-eighties", "tomorrow-night-blue", "tomorrow-night-bright"
url : # the base hostname & protocol for your site e.g. https://www.someone.com
url : https://wing-summer.github.io/WingHexExplorer2 # the base hostname & protocol for your site e.g. https://www.someone.com
baseurl : # does not include hostname
title : wingsummer/WingHexExplorer2
title : WingHexExplorer2
description: > # this means to ignore newlines until "Language & timezone"
一个自由强大跨平台的十六进制编辑器
## => Language and Timezone
##############################
lang: # the language of your site, default as "en"
lang: zh-Hans # the language of your site, default as "en"
timezone: # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the available values
@ -49,14 +49,14 @@ author:
zhihu : # "user_name" the last part of your profile url, e.g. https://www.zhihu.com/people/user_name
douban : # "user_name" the last part of your profile url, e.g. https://www.douban.com/people/user_name
linkedin : # "user_name" the last part of your profile url, e.g. https://www.linkedin.com/in/user_name
github : https://github.com/Wing-summer
github : Wing-summer
npm : # "user_name" the last part of your profile url, e.g. https://www.npmjs.com/~user_name
## => GitHub Repository (if the site is hosted by GitHub)
##############################
repository: user_name/repo_name
repository_tree: master
repository: wingsummer/WingHexExplorer2
repository_tree: main
## => Paths
@ -74,13 +74,12 @@ paths:
excerpt_separator: <!--more-->
## license
license: CC-BY-NC-4.0 # "CC-BY-4.0", "CC-BY-SA-4.0", "CC-BY-NC-4.0", "CC-BY-ND-4.0"
license: BY-NC-SA-4.0 # "CC-BY-4.0", "CC-BY-SA-4.0", "CC-BY-NC-4.0", "CC-BY-ND-4.0", "BY-NC-SA-4.0"
## TOC
toc:
selectors: # "h1,h2,h3" (default)
## => Markdown Enhancements
##############################
## Mathjax
@ -88,7 +87,7 @@ mathjax: # false (default), true
mathjax_autoNumber: # false (default), true
## Mermaid
mermaid: # false (default), true
mermaid: true # false (default), true
## Chart
chart: # false (default), true
@ -184,8 +183,6 @@ highlighter : rouge
permalink : date
exclude:
- CHANGELOG.md
- HOW_TO_RELEASE.md
- Gemfile
- Gemfile.lock
- LICENSE
@ -195,11 +192,10 @@ exclude:
- jekyll-text-theme.gemspec
- package-lock.json
- package.json
- /docs
- /node_modules
- /screenshots
- /test
- /vendor
- .markdownlint.json
defaults:
- scope:
@ -214,6 +210,21 @@ defaults:
show_edit_on_github: true
show_subscribe: true
pageview: true
- scope:
path: "docs/zh"
values:
layout: article
sidebar:
nav: docs-zh
license: true
aside:
toc: true
lang: zh
title: "文档"
show_edit_on_github: false
show_title: false
show_date: false
## => Plugins

View File

@ -14,3 +14,7 @@ CC-BY-ND-4.0:
name: Attribution-NoDerivatives 4.0 International
url: https://creativecommons.org/licenses/by-nd/4.0/
image: https://i.creativecommons.org/l/by-nd/4.0/88x31.png
BY-NC-SA-4.0:
name: Attribution-NonCommercial-ShareAlike 4.0 International
url: https://creativecommons.org/licenses/by-nc-sa/4.0/
image: https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png

View File

@ -20,6 +20,7 @@ en: &EN
EMAIL_ME : "Send me an Email."
EMAIL_US : "Send us an Email."
COPYRIGHT_DATES : "2021"
DOCUMENT : "Docs"
en-GB:
<<: *EN
@ -51,6 +52,7 @@ zh-Hans: &ZH_HANS
EMAIL_ME : "给我发邮件。"
EMAIL_US : "给我们发邮件。"
COPYRIGHT_DATES : "2021"
DOCUMENT : "文档"
zh:
<<: *ZH_HANS
@ -80,6 +82,7 @@ zh-Hant: &ZH_HANT
EMAIL_ME : "給我發郵件。"
EMAIL_US : "給我們發郵件。"
COPYRIGHT_DATES : "2021"
DOCUMENT : "文檔"
zh-TW:
<<: *ZH_HANT
@ -107,6 +110,7 @@ ko: &KO
EMAIL_ME : "이메일 보내기"
EMAIL_US : "이메일 보내기"
COPYRIGHT_DATES : "2021"
DOCUMENT : "문서"
ko-KR:
<<: *KO
@ -133,6 +137,7 @@ fr: &FR
EMAIL_US : "Envoyez-nous un courriel"
COPYRIGHT_DATES : "2021"
DONATE : "Faites un don de [NAME]."
DOCUMENT : "Docs"
fr-BE:
<<: *FR
@ -165,5 +170,6 @@ tr: &TR
EMAIL_ME : "Bana email ile ulaşın."
EMAIL_US : "Bize email ile ulaşın."
COPYRIGHT_DATES : "2021"
DOCUMENT : "Belgeler"
# @end locale config

View File

@ -1,4 +1,33 @@
header:
- title: GitHub
url: https://github.com/Wing-summer/WingHexExplorer2
- titles:
# @start locale config
en : &EN Docs
en-GB : *EN
en-US : *EN
en-CA : *EN
en-AU : *EN
zh-Hans : &ZH_HANS 文档
zh : *ZH_HANS
zh-CN : *ZH_HANS
zh-SG : *ZH_HANS
zh-Hant : &ZH_HANT 文檔
zh-TW : *ZH_HANT
zh-HK : *ZH_HANT
ko : &KO 문서
ko-KR : *KO
fr : &FR Docs
fr-BE : *FR
fr-CA : *FR
fr-CH : *FR
fr-FR : *FR
fr-LU : *FR
tr : &TR Belgeler
# @end locale config
url: /docs/DocsIndex.html
- titles:
# @start locale config
en : &EN Archive
@ -50,3 +79,22 @@ header:
tr : &TR Hakkında
# @end locale config
url: /about.html
docs-zh:
- title: 鸣谢
children:
- title: 鸣谢与说明
key: docs-credits
url: /docs/zh/credits.html
- title: 入门
children:
- title: 简介
key: docs-introduction
url: /docs/zh/introduction.html
- title: 基础
key: docs-basis
url: /docs/zh/basis.html
- title: 插件开发
- title: 其他语言

View File

@ -9,12 +9,10 @@
{%- if _item.children -%}
{%- for _child in _item.children -%}
{%- include snippets/get-nav-url.html path=_child.url -%}
{%- assign _nav_url = __return -%}
{%- include snippets/get-nav-url.html path=page.url -%}
{%- assign _page_url = __return -%}
{%- assign _nav_key = _child.key -%}
{%- assign _page_key = page.key -%}
{%- if _nav_url == _page_url -%}
{%- if _nav_key == _page_key -%}
{%- assign _find_cur = true -%}
{%- elsif _find_cur and _find_next != true -%}
{%- assign _find_next = true -%}
@ -27,6 +25,12 @@
{%- endif -%}
{%- endfor -%}
{%- if _find_cur != true -%}
{%- assign _previous = page.previous -%}
{%- assign _next = page.next -%}
{%- endif -%}
{%- endif -%}
{%- else -%}

View File

@ -5,7 +5,7 @@
{%-assign _license_name = '<a itemprop="license" rel="license" href="[URL]">[NAME]</a>' | replace: "[URL]", include.license.url | replace: "[NAME]", include.license.name -%}
<div class="license">
<p>{{ _license_announce | replace: "[LICENSE]", _license_name }}
<p align="center">{{ _license_announce | replace: "[LICENSE]", _license_name }}
<a rel="license" href="{{ include.license.url }}">
<img alt="{{ include.license.name }}" src="{{ include.license.image }}" />
</a>

View File

@ -1,26 +1,6 @@
<!-- start favicons snippet, use https://realfavicongenerator.net/ -->
{%- include snippets/prepend-baseurl.html path='/assets/apple-touch-icon.png' -%}
<link rel="apple-touch-icon" sizes="180x180" href="{{ __return }}">
{%- include snippets/prepend-baseurl.html path='/assets/favicon-32x32.png' -%}
<link rel="icon" type="image/png" sizes="32x32" href="{{ __return }}">
{%- include snippets/prepend-baseurl.html path='/assets/favicon-16x16.png' -%}
<link rel="icon" type="image/png" sizes="16x16" href="{{ __return }}">
{%- include snippets/prepend-baseurl.html path='/assets/site.webmanifest' -%}
<link rel="manifest" href="{{ __return }}">
{%- include snippets/prepend-baseurl.html path='/assets/safari-pinned-tab.svg' -%}
<link rel="mask-icon" href="{{ __return }}" color="#fc4d50">
{%- include snippets/prepend-baseurl.html path='/assets/favicon.ico' -%}
<link rel="shortcut icon" href="{{ __return }}">
<meta name="msapplication-TileColor" content="#ffc40d">
{%- include snippets/prepend-baseurl.html path='/assets/browserconfig.xml' -%}
<meta name="msapplication-config" content="{{ __return }}">
<meta name="theme-color" content="#ffffff">
<!-- end favicons snippet -->
<link rel="icon" type="image/png" href="/assets/favicon-96x96.png" sizes="96x96" />
<link rel="icon" type="image/svg+xml" href="/assets/favicon.svg" />
<link rel="shortcut icon" href="/assets/favicon.ico" />
<link rel="apple-touch-icon" sizes="180x180" href="/assets/apple-touch-icon.png" />
<meta name="apple-mobile-web-app-title" content="WingHexExplorer2" />
<link rel="manifest" href="/assets/site.webmanifest" />

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 424 B

After

Width:  |  Height:  |  Size: 41 KiB

View File

@ -1,12 +0,0 @@
---
title: Post with Header Image
tags: TeXt
article_header:
type: cover
image:
src: /screenshot.jpg
---
A Post with Header Image, See [Page layout](https://kitian616.github.io/jekyll-TeXt-theme/samples.html#page-layout) for more examples.
<!--more-->

View File

@ -1,16 +0,0 @@
---
title: Welcome
tags: TeXt
---
If you see this page, that means you have setup your site. enjoy! :ghost: :ghost: :ghost:
You may want to [config the site](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/configuration) or [writing a post](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/writing-posts) next. Please feel free to [create an issue](https://github.com/kitian616/jekyll-TeXt-theme/issues) or [send me email](mailto:kitian616@outlook.com) if you have any questions.
<!--more-->
---
If you like TeXt, don't forget to give me a star. :star2:
[![Star This Project](https://img.shields.io/github/stars/kitian616/jekyll-TeXt-theme.svg?label=Stars&style=social)](https://github.com/kitian616/jekyll-TeXt-theme/)

View File

@ -1,3 +1,53 @@
/* start custom scss snippet */
kbd {
display: inline-block;
padding: 0.25rem;
font: 11px ui-monospace, SFMono-Regular, SF Mono, Menlo, Consolas, Liberation Mono, monospace;
line-height: 10px;
color: #f0f6fc;
vertical-align: middle;
background-color: #151b23;
border: solid 1px #3d444db3;
border-bottom-color: #3d444db3;
border-radius: 6px;
box-shadow: inset 0 -1px 0 #3d444db3;
}
ul, ol, dl {
padding: 1.5em;
}
h1, h2, h3, h4, h5, h6{
margin: 0.5em 0 0 0 !important;
}
code {
padding: 0.5rem;
margin: 0.5rem !important;
font-size: 1em;
}
.page__main .col-aside > aside {
width: auto;
}
ul.toc .toc-h2, ul.toc .toc-h2 a, ul.toc .toc-h3, ul.toc .toc-h3 a, ul.toc .toc-h4, ul.toc .toc-h4 a, ul.toc .toc-h5, ul.toc .toc-h5 a, ul.toc .toc-h6, ul.toc .toc-h6 a {
font-size: 1em;
line-height: normal;
}
::-webkit-scrollbar{width:10px;height:10px}
::-webkit-scrollbar-track{background:gray}
::-webkit-scrollbar-thumb:hover{background:#e68600}
::-webkit-scrollbar-corner{background:#179a16}
::-webkit-scrollbar-thumb{box-shadow:inset 0 0 5px rgba(0,0,0,0.2);background:#535353}
p.warning {
padding: 0.5rem 1rem;
background-color: rgba(250, 140, 22, 0.1);
border: 1px solid #fa8c16;
border-radius: 0.4rem;
}
/* end custom scss snippet */

View File

@ -1,5 +1,6 @@
---
layout: article
show_title: false
titles:
# @start locale config
en : &EN About
@ -26,49 +27,45 @@ titles:
key: page-about
---
![TeXt Theme](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/TeXt-home.jpg)
## 关于软件
TeXt is a super customizable Jekyll theme for personal site, team site, blog, project, documentation, etc. Similar to iOS 11 style, it has large and prominent titles, round buttons and cards.
<p align="center">
<img alt="" src="{{site.url}}/assets/images/appicon.png" width=200 />
</p>
```javascript
(() => console.log('Hello, World!'))();
```
该软件起源于`WingHexExplorer`,是它的重构翻新版本,修复了大量的 Bug增强功能。原来的版本是基于`DTK`做的,所以仅仅支持某些`Linux`发行版。原本在`Linux`上没有发现跟`Windows`上媲美好用的开源软件,于是在 2022 年 6 月,我创建了代码仓库开始开发,最后依次更新是在 2023 年 7 月,持续了一年的时间。最后软件长这个样子:
## Features
<p align="center">
<img alt="" src="{{site.url}}/assets/images/old-screenshot.png"/>
</p>
- Responsive
- Semantic HTML
- Skins
- Highlight Theme
- Internationalization
- Search
- Table of contents
- Authors
- Additional styles (alert, tag, image, icon, button, grid, etc)
- Extensions (audios, videos, slides, demos)
- Markdown enhancements ([MathJax](https://www.mathjax.org/), [mermaid](https://mermaidjs.github.io/), [chartjs](http://www.chartjs.org/))
- Sharing ([AddToAny](https://www.addtoany.com/), [AddThis](https://www.addthis.com/))
- Comments ([Disqus](https://disqus.com/), [Gitalk](https://gitalk.github.io/), [Valine](https://valine.js.org/en/))
- Pageview ([LeanCloud](https://leancloud.cn/))
- Analytics ([Google Analytics](https://analytics.google.com/analytics/web/))
- RSS ([jekyll-feed](https://github.com/jekyll/jekyll-feed))
从图上看,这其实是我现在十六进制编辑器的原型。此时软件已经具备插件系统和`Python`脚本的支持,不过仅支持单文件编辑,也没有特别强大,但已经十分够用,并且具有一定的复杂度和专业性。
## Skins
后来,我不再打算拘泥于`Deepin`这个操作系统,后面它的更新设计让我有点疲惫。在 2024 年 06 月我开启了新的项目`WingHexExplorer2`,对原有的`WingHexExplorer`的重构和功能增强。最初的目的是摆脱`DTK`,在`UI`设计上耗费了我大量的精力,后来逐步定型了,然后我在`Deepin`论坛上发布了初步代码仓库开放的帖子,一直坚持至今。
TeXt has 6 built-in skins, you can also set up your own skin.
这个软件从始至终都是我一个人开发的:我自己独立选用现有的开源库,阅读源代码,然后定制、修复原有的 Bug。如果原作者还在维护我就提一个 PR看看我的修复能不能合并到里面。自己独立写了上百万行代码建立起目前具有专业功能的二进制分析和编辑软件。
| `default` | `dark` | `forest` |
| --- | --- | --- |
| ![Default](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_default.jpg) | ![Dark](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_dark.jpg) | ![Forest](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_forest.jpg) |
当然,目前软件仍有一些不足,在`v2.1.0`版本,这个软件会更上一层楼,功能更强大。最重要的是插件系统更强大,也带来了我编写的两个插件。从此以后,我将仅仅简单维护软件,有 Bug 有时间就修,没时间拉倒。有赞助就能够开心几天,心情好了有时间给软件完成一些`TODO`。
| `ocean` | `chocolate` | `orange` |
| --- | --- | --- |
| ![Ocean](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_ocean.jpg) | ![Chocolate](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_chocolate.jpg) | ![Orange](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_orange.jpg) |
## 关于作者
### Highlight Theme
<p align="center">
<img alt="作者" src="{{site.url}}/assets/images/author.jpg" width=200 />
</p>
TeXt use [Tomorrow](https://github.com/chriskempson/tomorrow-theme) as the highlight theme.
网名/昵称是寂静的羽夏,英文网名有`wingsummer`、`Wing-summer`或`WingSummer`这三种。中国人,羽云系列软件发起人和目前唯一维护者,一个热爱开源的非科班专业贡献者,是一位热爱计算机技术的菜鸟。目前在维护的代表作:[WingHexExplorer2](https://github.com/Wing-summer/WingHexExplorer2)、[WingGifEditor2](https://github.com/Wing-summer/WingGifEditor2) 以及相关插件。
| `tomorrow` | `tomorrow-night` | `tomorrow-night-eighties` | `tomorrow-night-blue` | `tomorrow-night-bright` |
| --- | --- | --- | --- | --- |
| ![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) |
拥有个人博客 [博客园](https://www.cnblogs.com/wingsummer) 。领域主要有软件逆向、`Windows`内核、软件加壳、`C/C++`语言底层实现以及其他略有涉猎的计算机基础知识。
目前作者是一名在读研究生,主要负责对基于光学相干断层成像相关的医疗设备的配套软件进行开发。经常使用的程序栈是`Qt C++`,当然也会`C#`、`Python`,也略懂一点`JavaScript`和前端。
开源不易,如有闲钱可支持我:
> If you are not Chinese, you can use [Afadian](https://afdian.com/a/wingsummer) to support me.
<p align="center"><b>您的每一份支持都将是我开源的强大动力,十分感谢您的支持</b></p>
<p align="center">
<img alt="捐助" src="{{site.url}}/assets/images/Donate.jpg" />
<p align="center">感谢支持</p>
</p>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.0 KiB

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 655 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 931 B

BIN
assets/favicon-96x96.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

3
assets/favicon.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 41 KiB

BIN
assets/images/Donate.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 124 KiB

BIN
assets/images/appicon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="130" height="20" role="img" aria-label="Author: Wingsummer"><title>Author: Wingsummer</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="130" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="47" height="20" fill="#555"/><rect x="47" width="83" height="20" fill="#97ca00"/><rect width="130" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="245" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="370">Author</text><text x="245" y="140" transform="scale(.1)" fill="#fff" textLength="370">Author</text><text aria-hidden="true" x="875" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="730">Wingsummer</text><text x="875" y="140" transform="scale(.1)" fill="#fff" textLength="730">Wingsummer</text></g></svg>

After

Width:  |  Height:  |  Size: 1.1 KiB

View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="112" height="20" role="img" aria-label="License: AGPL-3.0"><title>License: AGPL-3.0</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="112" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="51" height="20" fill="#555"/><rect x="51" width="61" height="20" fill="#e05d44"/><rect width="112" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="265" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="410">License</text><text x="265" y="140" transform="scale(.1)" fill="#fff" textLength="410">License</text><text aria-hidden="true" x="805" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">AGPL-3.0</text><text x="805" y="140" transform="scale(.1)" fill="#fff" textLength="510">AGPL-3.0</text></g></svg>

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 345 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 173 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 204 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 584 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 224 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 324 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 177 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 119 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 127 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.9 KiB

View File

@ -1,38 +0,0 @@
<?xml version="1.0" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 20010904//EN"
"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
<svg version="1.0" xmlns="http://www.w3.org/2000/svg"
width="700.000000pt" height="700.000000pt" viewBox="0 0 700.000000 700.000000"
preserveAspectRatio="xMidYMid meet">
<metadata>
Created by potrace 1.11, written by Peter Selinger 2001-2013
</metadata>
<g transform="translate(0.000000,700.000000) scale(0.100000,-0.100000)"
fill="#000000" stroke="none">
<path d="M2735 6469 c-98 -14 -126 -21 -178 -38 -188 -66 -289 -166 -332 -327
-15 -58 -22 -232 -11 -284 3 -14 8 -41 11 -60 5 -32 4 -31 -10 10 -31 86 -104
227 -143 277 -51 64 -127 119 -199 144 -69 25 -189 31 -255 13 -27 -7 -48 -11
-48 -9 0 2 -33 -8 -72 -22 -193 -67 -452 -232 -702 -446 -27 -23 -60 -51 -73
-62 -14 -11 -70 -63 -126 -116 l-101 -96 66 -69 c90 -94 114 -121 178 -194 30
-35 60 -68 66 -74 5 -6 53 -65 105 -131 374 -471 603 -905 724 -1370 33 -127
37 -148 56 -270 24 -157 33 -457 17 -620 -54 -579 -307 -1149 -767 -1729 -98
-125 -114 -144 -196 -235 -54 -59 -60 -66 -120 -132 l-40 -44 50 46 c76 71
104 96 175 158 36 31 70 61 76 66 14 13 72 60 154 125 36 28 73 57 83 65 9 8
21 15 26 15 5 0 11 3 13 8 14 34 381 264 578 362 167 84 435 191 518 206 13 3
42 11 65 18 23 8 56 17 72 20 17 4 41 9 55 12 81 16 185 33 245 39 39 4 81 8
95 11 32 5 334 5 380 -1 19 -2 58 -7 86 -10 29 -3 62 -8 75 -10 13 -3 44 -8
69 -11 25 -3 53 -8 62 -10 10 -3 29 -7 42 -10 113 -20 342 -93 501 -159 112
-46 346 -164 406 -205 24 -16 48 -30 52 -30 20 0 346 -230 487 -343 173 -139
259 -215 403 -355 l99 -96 102 104 c55 58 128 136 161 174 33 37 65 73 70 80
32 36 129 163 181 236 301 423 344 745 130 953 -63 61 -216 145 -326 180 -8 2
-1 2 15 0 284 -42 449 -5 574 129 105 111 163 330 155 588 -3 110 -13 245 -19
275 -5 23 -14 82 -21 140 -3 22 -14 81 -24 130 -11 50 -21 101 -24 115 -6 36
-75 311 -85 340 -5 14 -19 59 -31 100 -24 82 -74 227 -95 275 -7 17 -26 62
-43 100 -147 339 -345 550 -573 610 -263 70 -586 -69 -944 -404 -57 -54 -54
-41 5 19 35 35 140 171 186 240 109 162 183 332 199 455 7 51 8 158 2 185 -2
8 -7 33 -12 55 -28 141 -168 324 -330 430 -47 31 -213 125 -221 125 -2 0 -32
13 -66 29 -134 61 -322 122 -543 178 -33 8 -67 16 -75 18 -25 7 -303 65 -330
70 -14 2 -45 7 -70 10 -25 3 -70 10 -100 15 -30 5 -80 12 -110 16 -79 9 -396
12 -455 3z"/>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 2.3 KiB

View File

@ -1,19 +1,21 @@
{
"name": "TeXt Theme",
"short_name": "TeXt Theme",
"icons": [
{
"src": "android-chrome-192x192.png",
"sizes": "192x192",
"type": "image/png"
},
{
"src": "android-chrome-512x512.png",
"sizes": "512x512",
"type": "image/png"
}
],
"theme_color": "#ffffff",
"background_color": "#ffffff",
"display": "standalone"
}
"name": "MyWebSite",
"short_name": "MySite",
"icons": [
{
"src": "/web-app-manifest-192x192.png",
"sizes": "192x192",
"type": "image/png",
"purpose": "maskable"
},
{
"src": "/web-app-manifest-512x512.png",
"sizes": "512x512",
"type": "image/png",
"purpose": "maskable"
}
],
"theme_color": "#ffffff",
"background_color": "#ffffff",
"display": "standalone"
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

10
docs/DocsIndex.md Normal file
View File

@ -0,0 +1,10 @@
---
layout: article
title: 文档
---
目前仅有中文简体文档,并且仍在建设中,请点击 [此链接](zh/credits.html) 。
如果您对本软件有兴趣并且想提供您的本土化翻译文档,可以`fork`本分支,将相应的内容进行补充,然后向作者仓库提交`PR`。
If you are interested in this software and want to contribute documents with your native language translation, you can `fork` this branch, add the corresponding content, and then submit a `PR` to the author's repository.

View File

@ -1,297 +0,0 @@
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely need to edit after that.
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'jekyll serve'. If you change this file, please restart the server process.
#
# ,--------. ,--. ,--. ,--.
# '--. .--',---. \ `.' /,-' '-.
# | | | .-. : .' \ '-. .-'
# | | \ --. / .'. \ | |
# `--' `----''--' '--' `--'
# config file for development, DELETE IT IF YOU WANT.
## => Site Settings
##############################
text_skin: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
highlight_theme: default # "default" (default), "tomorrow", "tomorrow-night", "tomorrow-night-eighties", "tomorrow-night-blue", "tomorrow-night-bright"
url : # the base hostname & protocol for your site e.g. https://www.someone.com
baseurl : # does not include hostname
title : TeXt Theme
description: > # this means to ignore newlines until "Language & timezone"
TeXt Theme for development.
## => Language and Timezone
##############################
lang: # the language of your site, default as "en"
timezone: # see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the available values
## => Author and Social
##############################
author:
type : organization # "person" (default), "organization"
name : TeXt
url :
avatar : /assets/apple-touch-icon.png
bio: >
TeXt Theme for development.
email : 1
facebook : 1
twitter : 1
weibo : 1
googleplus: 1
telegram : 1
medium : 1
zhihu : 1
douban : 1
linkedin : 1
github : 1
npm : 1
## => GitHub Repository (if the site is hosted by GitHub)
##############################
repository: kitian616/jekyll-TeXt-theme
repository_tree: master
## => Paths
##############################
paths:
root : # title link url, "/" (default)
home : /test/ # home layout url, "/" (default)
archive : # "/archive.html" (default)
rss : # "/feed.xml" (default)
## => Post
##############################
## excerpt
excerpt_separator: <!--more-->
## license
license: CC-BY-4.0 # "CC-BY-4.0", "CC-BY-SA-4.0", "CC-BY-NC-4.0", "CC-BY-ND-4.0"
## TOC
toc:
selectors: "h1,h2,h3,h4,h5,h6" # "h1,h2,h3" (default)
## => Markdown Enhancements
##############################
## Mathjax
mathjax: true # false (default), true
mathjax_autoNumber: true # false (default), true
## Mermaid
mermaid: true # false (default), true
## Chart
chart: true # false (default), true
## => Paginate
##############################
paginate: 4
paginate_path: /test/page:num # don't change this unless for special need
## => Sources
##############################
sources: unpkg # bootcdn (default), unpkg
## => Sharing
##############################
sharing:
provider: addtoany # false (default), "addtoany", "addthis", "custom"
## AddThis
addthis:
id: # AddThis pubid, e.g. ra-5xxxxxxxxxxx
## => Comments
##############################
comments:
provider: false # false (default), "disqus", "gitalk", "valine", "custom"
## Disqus
disqus:
shortname: # the Disqus shortname for the site
## Gitalk
# please refer to https://github.com/gitalk/gitalk for more info.
gitalk:
clientID : # GitHub Application Client ID
clientSecret: # GitHub Application Client Secret
repository : # GitHub repo
owner : # GitHub repo owner
admin: # GitHub repo owner and collaborators, only these guys can initialize GitHub issues, IT IS A LIST.
# - your GitHub Id
## Valine
# please refer to https://valine.js.org/en/ for more info.
valine:
app_id : # LeanCloud App id
app_key : # LeanCloud App key
placeholder : # Prompt information
visitor : # false (default)
meta : # "[nick, mail, link]" (default) nickname, E-mail, Personal-site
## => Pageview
##############################
pageview:
provider: false # false (default), "leancloud", "custom"
## Leancloud
leancloud:
app_id : # LeanCloud App id
app_key : # LeanCloud App key
app_class : # LeanCloud App class
## => Search
##############################
search:
provider: default # "default" (default), false, "google", "custom"
## Google Custom Search Engine
google:
# custom_search_engine_id: 017643444788069204610:4gvhea_mvga # Google Custom Search Engine ID
## => Analytics
##############################
analytics:
provider: false # false (default), "google", "custom"
## Google Analytics
google:
tracking_id : # Google Analytics id for the site
anonymize_ip: false # Anonymize IP tracking for Analytics
## => Build
##############################
markdown : kramdown
highlighter : rouge
permalink : date
exclude:
- CHANGELOG.md
- HOW_TO_RELEASE.md
- Gemfile
- Gemfile.lock
- LICENSE
- README-*.md
- README.md
- gulpfile.js
- jekyll-text-theme.gemspec
- package-lock.json
- package.json
# - /docs
- /node_modules
# - /screenshots
# - /test
- /vendor
- /_posts
- /index.html
collections_dir: docs
collections:
docs:
output: true
sample_page:
output: true
sample_articles:
output: true
sample_languages:
output: true
defaults:
## home
- scope:
path: "test"
values:
articles:
excerpt_type: html
## posts
- scope:
path: ""
type: posts
values:
layout: article
sharing: true
license: true
category: post
aside:
toc: true
show_edit_on_github: true
show_subscribe: true
pageview: true
lightbox: true
## samples
- scope:
path: ""
type: sample_page
values:
nav_key: samples
- scope:
path: ""
type: sample_articles
values:
nav_key: samples
show_date: false
- scope:
path: ""
type: sample_languages
values:
layout: article
nav_key: samples
show_date: false
## docs
- scope:
path: "_docs/en"
values:
layout: article
nav_key: docs
sidebar:
nav: docs-en
license: true
aside:
toc: true
show_edit_on_github: true
show_date: false
lightbox: true
- scope:
path: "_docs/zh"
values:
layout: article
nav_key: docs
sidebar:
nav: docs-zh
license: true
aside:
toc: true
lang: zh
show_edit_on_github: true
show_date: false
lightbox: true
## => Plugins
##############################
plugins:
# - jekyll-feed
- jekyll-paginate
# - jekyll-sitemap
- jemoji
data_dir: /docs/_data

View File

@ -1,299 +0,0 @@
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely need to edit after that.
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'jekyll serve'. If you change this file, please restart the server process.
#
# ,--------. ,--. ,--. ,--.
# '--. .--',---. \ `.' /,-' '-.
# | | | .-. : .' \ '-. .-'
# | | \ --. / .'. \ | |
# `--' `----''--' '--' `--'
# config file for demo site, DELETE IT IF YOU WANT.
## => Site Settings
##############################
text_skin: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
highlight_theme: default # "default" (default), "tomorrow", "tomorrow-night", "tomorrow-night-eighties", "tomorrow-night-blue", "tomorrow-night-bright"
url : https://kitian616.github.io
baseurl : /jekyll-TeXt-theme
title : TeXt Theme
description: >
A super customizable Jekyll theme for personal site, team site, blog, project, documentation, etc.
## => Language and Timezone
##############################
lang: en # the language of your site, default as "en"
timezone: Asia/Shanghai
## => Author and Social
##############################
author:
type : organization # "person" (default), "organization"
name : TeXt
url :
avatar : /assets/apple-touch-icon.png
bio: >
TeXt is a super customizable Jekyll theme for personal site, team site, blog, project, documentation, etc.
Similar to iOS 11 style, it has large and prominent titles, round buttons and cards.
email : kitian616@outlook.com
facebook :
twitter : kitian616
weibo : 234695683
googleplus: 101827554735084402671
telegram :
medium :
zhihu :
douban :
linkedin :
github : kitian616/jekyll-TeXt-theme
npm :
## => GitHub Repository (if the site is hosted by GitHub)
##############################
repository: kitian616/jekyll-TeXt-theme
repository_tree: master
## => Paths
##############################
paths:
root : # title link url, "/" (default)
home : /test/ # home layout url, "/" (default)
archive : # "/archive.html" (default)
rss : # "/feed.xml" (default)
## => Post
##############################
## excerpt
excerpt_separator: <!--more-->
## license
license: CC-BY-4.0 # "CC-BY-4.0", "CC-BY-SA-4.0", "CC-BY-NC-4.0", "CC-BY-ND-4.0"
## TOC
toc:
selectors: # "h1,h2,h3" (default)
## => Markdown Enhancements
##############################
## Mathjax
mathjax: true # false (default), true
mathjax_autoNumber: true # false (default), true
## Mermaid
mermaid: true # false (default), true
## Chart
chart: true # false (default), true
## => Paginate
##############################
paginate: 8
paginate_path: /test/page:num # don't change this unless for special need
## => Sources
##############################
sources: # bootcdn (default), unpkg
## => Sharing
##############################
sharing:
provider: addthis # false (default), "addtoany", "addthis", "custom"
## AddThis
addthis:
id: ra-5be59ee2486770cb # AddThis pubid, e.g. ra-5xxxxxxxxxxx
## => Comments
##############################
comments:
provider: gitalk # false (default), "disqus", "gitalk", "valine", "custom"
# provider: valine
## Disqus
disqus:
shortname: # the Disqus shortname for the site
## Gitalk
# please refer to https://github.com/gitalk/gitalk for more info.
gitalk:
clientID : 143666b578a416f82175
clientSecret: 1d1c0604a1a4bff9b59ab7f56724dc0e8b837775
repository : gitalk-demo
owner : kitian616
admin:
- kitian616
## Valine
# please refer to https://valine.js.org/en/ for more info.
valine:
app_id : uAG3OhdcH8H4fxSqXLyBljA7-gzGzoHsz
app_key : Mzf5m9skSwYVWVXhGiYMNyXs
placeholder : # Prompt information
visitor : # false (default)
meta : # "[nick, mail, link]" (default) nickname, E-mail, Personal-site
## => Pageview
##############################
pageview:
provider: leancloud # false (default), "leancloud", "custom"
## Leancloud
leancloud:
app_id : uAG3OhdcH8H4fxSqXLyBljA7-gzGzoHsz
app_key : Mzf5m9skSwYVWVXhGiYMNyXs
app_class : TeXtDemo
## => Search
##############################
search:
provider: default # "default" (default), false, "google", "custom"
## Google Custom Search Engine
google:
custom_search_engine_id: # Google Custom Search Engine ID
## => Analytics
##############################
analytics:
provider: google # false (default), "google", "custom"
## Google Analytics
google:
tracking_id : UA-71907556-1
anonymize_ip: false
## => Build
##############################
markdown : kramdown
highlighter : rouge
permalink : date
exclude:
- CHANGELOG.md
- HOW_TO_RELEASE.md
- Gemfile
- Gemfile.lock
- LICENSE
- README-*.md
- README.md
- gulpfile.js
- jekyll-text-theme.gemspec
- package-lock.json
- package.json
# - /docs
- /node_modules
# - /screenshots
# - /test
- /vendor
- /_posts
- /index.html
collections_dir: docs
collections:
docs:
output: true
sample_page:
output: true
sample_articles:
output: true
sample_languages:
output: true
defaults:
## home
- scope:
path: "test"
values:
articles:
excerpt_type: html
## posts
- scope:
path: ""
type: posts
values:
layout: article
sharing: true
license: true
category: post
aside:
toc: true
show_edit_on_github: true
show_subscribe: true
pageview: true
# lightbox: true
## samples
- scope:
path: ""
type: sample_page
values:
nav_key: samples
- scope:
path: ""
type: sample_articles
values:
nav_key: samples
show_date: false
- scope:
path: ""
type: sample_languages
values:
layout: article
nav_key: samples
show_date: false
## docs
- scope:
path: "_docs/en"
values:
layout: article
nav_key: docs
sidebar:
nav: docs-en
license: true
aside:
toc: true
show_edit_on_github: true
show_date: false
# lightbox: true
- scope:
path: "_docs/zh"
values:
layout: article
nav_key: docs
sidebar:
nav: docs-zh
license: true
aside:
toc: true
lang: zh
show_edit_on_github: true
show_date: false
# lightbox: true
## => Plugins
##############################
plugins:
- jekyll-feed
- jekyll-paginate
- jekyll-sitemap
- jemoji
data_dir: /docs/_data

View File

@ -1,17 +0,0 @@
Tian Qi:
name: Tian Qi # your Name
url: https://kitian616.github.io
avatar: https://wx3.sinaimg.cn/large/73bd9e13ly1fjkqy66hl8j208c08c0td.jpg # your photo
bio: The Creator of TeXt.
email: kitian616@outlook.com
facebook : # "user_name" the last part of your profile url, e.g. https://www.facebook.com/user_name
twitter : kitian616 # "user_name" the last part of your profile url, e.g. https://twitter.com/user_name
weibo : 234695683 # "user_id" the last part of your profile url, e.g. https://www.weibo.com/user_id/profile?...
googleplus: 101827554735084402671 # "user_id" the last part of your profile url, e.g. https://plus.google.com/u/0/user_id
telegram : # "user_name" the last part of your profile url, e.g. https://t.me/user_name
medium : # "user_name" the last part of your profile url, e.g. https://medium.com/user_name
zhihu : # "user_name" the last part of your profile url, e.g. https://www.zhihu.com/people/user_name
douban : # "user_name" the last part of your profile url, e.g. https://www.douban.com/people/user_name
linkedin : # "user_name" the last part of your profile url, e.g. https://www.linkedin.com/in/user_name
github : kitian616 # "user_name" the last part of your profile url, e.g. https://github.com/user_name
npm : # "user_name" the last part of your profile url, e.g. https://www.npmjs.com/~user_name

View File

@ -1,16 +0,0 @@
CC-BY-4.0:
name: Attribution 4.0 International
url: https://creativecommons.org/licenses/by/4.0/
image: https://i.creativecommons.org/l/by/4.0/88x31.png
CC-BY-SA-4.0:
name: Attribution-ShareAlike 4.0 International
url: https://creativecommons.org/licenses/by-sa/4.0/
image: https://i.creativecommons.org/l/by-sa/4.0/88x31.png
CC-BY-NC-4.0:
name: Attribution-NonCommercial 4.0 International
url: https://creativecommons.org/licenses/by-nc/4.0/
image: https://i.creativecommons.org/l/by-nc/4.0/88x31.png
CC-BY-ND-4.0:
name: Attribution-NoDerivatives 4.0 International
url: https://creativecommons.org/licenses/by-nd/4.0/
image: https://i.creativecommons.org/l/by-nd/4.0/88x31.png

View File

@ -1,170 +0,0 @@
# @start locale config
## => English
########################
en: &EN
SUBSCRIBE : "Subscribe"
READMORE : "Read more"
SEARCH : "Search"
CANCEL : "Cancel"
VIEWS : "views"
LAST_UPDATED : "Last updated"
PREVIOUS : "PREVIOUS"
NEXT : "NEXT"
ARTICLE_DATE_FORMAT : "%b %d, %Y"
ARTICLE_LIST_DATE_FORMAT: "%b %d"
STATISTICS : "[POST_COUNT] post articles, [PAGE_COUNT] pages."
LICENSE_ANNOUNCE : "This work is licensed under a [LICENSE] license."
POST_ON_GITHUB : "Edit on Github"
FOLLOW_ME : "Follow me on [NAME]."
FOLLOW_US : "Follow us on [NAME]."
EMAIL_ME : "Send me an Email."
EMAIL_US : "Send us an Email."
COPYRIGHT_DATES : "2021"
en-GB:
<<: *EN
en-US:
<<: *EN
en-CA:
<<: *EN
en-AU:
<<: *EN
## => Simplified Chinese
########################
zh-Hans: &ZH_HANS
SUBSCRIBE : "订阅"
READMORE : "阅读更多"
SEARCH : "搜索"
CANCEL : "取消"
VIEWS : "阅读"
LAST_UPDATED : "更新于"
PREVIOUS : "上篇"
NEXT : "下篇"
ARTICLE_DATE_FORMAT : "%Y年 %m月%d日"
ARTICLE_LIST_DATE_FORMAT: "%m月%d日"
STATISTICS : "共计 [POST_COUNT] 篇文章,[PAGE_COUNT] 页。"
LICENSE_ANNOUNCE : "本文遵守 [LICENSE] 许可协议。"
POST_ON_GITHUB : "在 Github 上修改"
FOLLOW_ME : "在 [NAME] 上关注我。"
FOLLOW_US : "在 [NAME] 上关注我们。"
EMAIL_ME : "给我发邮件。"
EMAIL_US : "给我们发邮件。"
COPYRIGHT_DATES : "2021"
zh:
<<: *ZH_HANS
zh-CN:
<<: *ZH_HANS
zh-SG:
<<: *ZH_HANS
## => Traditional Chinese
########################
zh-Hant: &ZH_HANT
SUBSCRIBE : "訂閱"
READMORE : "閱讀更多"
SEARCH : "搜索"
CANCEL : "取消"
VIEWS : "閱讀"
LAST_UPDATED : "更新於"
PREVIOUS : "上篇"
NEXT : "下篇"
ARTICLE_DATE_FORMAT : "%Y年 %m月%d日"
ARTICLE_LIST_DATE_FORMAT: "%m月%d日"
STATISTICS : "共計 [POST_COUNT] 篇文章,[PAGE_COUNT] 頁。"
LICENSE_ANNOUNCE : "本文遵守 [LICENSE] 許可協議。"
POST_ON_GITHUB : "在 Github 上修改"
FOLLOW_ME : "在 [NAME] 上關注我。"
FOLLOW_US : "在 [NAME] 上關注我們。"
EMAIL_ME : "給我發郵件。"
EMAIL_US : "給我們發郵件。"
COPYRIGHT_DATES : "2021"
zh-TW:
<<: *ZH_HANT
zh-HK:
<<: *ZH_HANT
## => Korean
########################
ko: &KO
SUBSCRIBE : "구독하기"
READMORE : "더보기"
SEARCH : "검색"
CANCEL : "취소"
VIEWS : "조회"
LAST_UPDATED : "마지막 수정"
PREVIOUS : "이전"
NEXT : "다음"
ARTICLE_DATE_FORMAT : "%Y년 %m월 %d일"
ARTICLE_LIST_DATE_FORMAT: "%m월 %d일"
STATISTICS : "전체 글 [POST_COUNT]개, [PAGE_COUNT] 페이지"
LICENSE_ANNOUNCE : "이 글의 저작권은 [LICENSE] 라이센스를 따릅니다."
POST_ON_GITHUB : "Github에서 확인하기"
FOLLOW_ME : "[NAME]에서 팔로우하기"
FOLLOW_US : "[NAME]에서 팔로우하기"
EMAIL_ME : "이메일 보내기"
EMAIL_US : "이메일 보내기"
COPYRIGHT_DATES : "2021"
ko-KR:
<<: *KO
## => French
########################
fr: &FR
SUBSCRIBE : "S'abonner"
READMORE : "Plus"
SEARCH : "Recherche"
CANCEL : "Annuler"
VIEWS : "vues"
LAST_UPDATED : "Dernière modification"
PREVIOUS : "PRÉCÉDENT"
NEXT : "SUIVANT"
ARTICLE_DATE_FORMAT : "%d %b, %Y"
ARTICLE_LIST_DATE_FORMAT: "%d %b"
STATISTICS : "[POST_COUNT] articles, [PAGE_COUNT] pages."
LICENSE_ANNOUNCE : "Ce travail est sous licence [LICENSE]."
POST_ON_GITHUB : "Modifier sur Github"
FOLLOW_ME : "Suivez-moi sur [NAME]."
FOLLOW_US : "Suivez-nous sur [NAME]."
EMAIL_ME : "Envoyez-moi un courriel."
EMAIL_US : "Envoyez-nous un courriel"
COPYRIGHT_DATES : "2021"
DONATE : "Faites un don de [NAME]."
fr-BE:
<<: *FR
fr-CA:
<<: *FR
fr-CH:
<<: *FR
fr-FR:
<<: *FR
fr-LU:
<<: *FR
## => Turkish
########################
tr: &TR
SUBSCRIBE : "Takip et"
READMORE : "Devamını Oku"
SEARCH : "İçerik Ara"
CANCEL : "İptal"
VIEWS : "gösterim"
LAST_UPDATED : "Son güncellenme"
PREVIOUS : "ÖNCEKİ"
NEXT : "SONRAKİ"
ARTICLE_DATE_FORMAT : "%d %b, %Y"
ARTICLE_LIST_DATE_FORMAT: "%d %b"
STATISTICS : "Toplam [POST_COUNT] adet gönderim ve [PAGE_COUNT] adet sayfa bulunuyor."
LICENSE_ANNOUNCE : "Bu içerik [LICENSE] ile lisanslanmıştır."
POST_ON_GITHUB : "Github üzerinde düzenle"
FOLLOW_ME : "Beni [NAME] üzerinden takip et."
FOLLOW_US : "Bizi [NAME] üzerinden takip edin."
EMAIL_ME : "Bana email ile ulaşın."
EMAIL_US : "Bize email ile ulaşın."
COPYRIGHT_DATES : "2021"
# @end locale config

View File

@ -1,142 +0,0 @@
header:
- title: Home
url: /test/
- title: Docs
url: /docs/en/quick-start
key: docs
- title: Samples
url: /samples.html
key: samples
- title: Archive
url: /archive.html
- title: About
url: /about.html
- title: GitHub
url: https://github.com/kitian616/jekyll-TeXt-theme
docs-en:
- title: Start
children:
- title: Quick Start
url: /docs/en/quick-start
- title: Structure
url: /docs/en/structure
- title: Update from 1.x to 2.x
url: /docs/en/update-from-1-to-2
- title: Customization
children:
- title: Configuration
url: /docs/en/configuration
- title: Navigation
url: /docs/en/navigation
- title: Layouts
url: /docs/en/layouts
- title: Logo and Favicon
url: /docs/en/logo-and-favicon
- title: Authors
url: /docs/en/authors
- title: Internationalization
url: /docs/en/i18n
- title: Content
children:
- title: Writing Posts
url: /docs/en/writing-posts
- title: Additional Styles
url: /docs/en/additional-styles
- title: Extensions
url: /docs/en/extensions
- title: Markdown Enhancements
url: /docs/en/markdown-enhancements
- title: Extra
children:
- title: Spacing
url: /docs/en/spacing
- title: Grid
url: /docs/en/grid
- title: Icons
url: /docs/en/icons
- title: Image
url: /docs/en/image
- title: Button
url: /docs/en/button
- title: Item
url: /docs/en/item
- title: Card
url: /docs/en/card
- title: Hero
url: /docs/en/hero
- title: Swiper
url: /docs/en/swiper
- title: Languages
children:
- title: 中文
url: /docs/zh/quick-start
docs-zh:
- title: 开始
children:
- title: 快速开始
url: /docs/zh/quick-start
- title: 从 1.x 升级到 2.x
url: /docs/zh/update-from-1-to-2
- title: 定制
children:
- title: 配置
url: /docs/zh/configuration
- title: 导航栏
url: /docs/zh/navigation
- title: 布局
url: /docs/zh/layouts
- title: Logo 和 Favicon
url: /docs/zh/logo-and-favicon
- title: 作者
url: /docs/zh/authors
- title: 国际化
url: /docs/zh/i18n
- title: 内容
children:
- title: 撰写博客
url: /docs/zh/writing-posts
- title: 附加样式
url: /docs/zh/additional-styles
- title: 扩展
url: /docs/zh/extensions
- title: Markdown 增强
url: /docs/zh/markdown-enhancements
- title: 其他语言
children:
- title: English
url: /docs/en/quick-start
layouts:
- title: Layouts
children:
- title: Single
url: /page/single.html
- title: Aside
url: /page/aside.html
- title: Sidebar
url: /page/sidebar.html
- title: Sidebar (Aside)
url: /page/sidebar-aside.html
- title: Article Header Overlay Background Fill
url: /page/article-header-overlay-background-fill.html
- title: Article Header Overlay Background Image
url: /page/article-header-overlay-background-image.html
- title: Article Header Image
url: /page/article-header-cover-image.html
- title: Article Header Overlay Background Image (Customized Header Background)
url: /page/article-header-overlay-background-image-header-background.html
- title: Article Header Image (Customized Header Background)
url: /page/article-header-cover-image-header-background.html
- title: Article Header Overlay Background Fill (Immersive + Translucent Header)
url: /page/article-header-overlay-background-fill-immersive-translucent-header.html
- title: Article Header Overlay Background Image (Immersive + Translucent Header)
url: /page/article-header-overlay-background-image-immersive-translucent-header.html
- title: Article Header Image (Immersive + Translucent Header)
url: /page/article-header-cover-image-immersive-translucent-header.html

View File

@ -1,64 +0,0 @@
default:
text_skin: default
highlight_theme: default
lang: en
paths:
root: /
home: /
archive: /archive.html
rss: /feed.xml
mathjax: false
mathjax_autoNumber: false
mermaid: false
chart: false
toc:
selectors: 'h1,h2,h3'
sources: bootcdn
page:
mode: normal
type: webpage
article_header:
align: left
theme: light
articles:
show_cover: true
show_excerpt: false
show_readmore: false
show_info: false
show_title: true
show_edit_on_github: false
show_date: true
show_tags: true
show_author_profile: false
show_subscribe: false
full_width: false
sharing: false
comment: true
license: false
pageview: false
search: default
sources:
bootcdn:
font_awesome: 'https://cdn.bootcdn.net/ajax/libs/font-awesome/5.15.1/css/all.css'
jquery: 'https://cdn.bootcss.com/jquery/3.1.1/jquery.min.js'
leancloud_js_sdk: '//cdn.jsdelivr.net/npm/leancloud-storage@3.13.2/dist/av-min.js'
chart: 'https://cdn.bootcss.com/Chart.js/2.7.2/Chart.bundle.min.js'
gitalk:
js: 'https://cdn.bootcss.com/gitalk/1.2.2/gitalk.min.js'
css: 'https://cdn.bootcss.com/gitalk/1.2.2/gitalk.min.css'
valine: 'https://unpkg.com/valine/dist/Valine.min.js' # bootcdn not available
mathjax: 'https://cdn.bootcss.com/mathjax/2.7.4/MathJax.js?config=TeX-MML-AM_CHTML'
mermaid: 'https://cdn.bootcss.com/mermaid/8.0.0-rc.8/mermaid.min.js'
unpkg:
font_awesome: 'https://use.fontawesome.com/releases/v5.15.1/css/all.css'
jquery: 'https://unpkg.com/jquery@3.3.1/dist/jquery.min.js'
leancloud_js_sdk: '//cdn.jsdelivr.net/npm/leancloud-storage@3.13.2/dist/av-min.js'
chart: 'https://unpkg.com/chart.js@2.7.2/dist/Chart.min.js'
gitalk:
js: 'https://unpkg.com/gitalk@1.2.2/dist/gitalk.min.js'
css: 'https://unpkg.com/gitalk@1.2.2/dist/gitalk.css'
valine: 'https//unpkg.com/valine/dist/Valine.min.js'
mathjax: 'https://unpkg.com/mathjax@2.7.4/unpacked/MathJax.js?config=TeX-MML-AM_CHTML'
mermaid: 'https://unpkg.com/mermaid@8.0.0-rc.8/dist/mermaid.min.js'

View File

@ -1,143 +0,0 @@
---
title: Quick Start
permalink: /docs/en/quick-start
key: docs-quick-start
---
TeXt Theme is 100% compatible with GitHub Pages and it has been developed as a [gem-based themes](https://jekyllrb.com/docs/themes/) for easier use.
In this document, you will learn how to **install the theme**, **setup your site**, **local preview** for development, **build** and **publish**.
<!--more-->
```mermaid
graph LR;
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)
F0[Installing Directly]
F1[Docker]
A0-->B0;
A0-->B1;
B0-->C0;
B0-->C1;
B0-->C2;
B1-->D0;
C1-->E0
C2-->E0
D0-->E0
E0-->F0
E0-->F1
```
## Installing the Theme
### Common Method
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.
**Clone with HTTPS:**
```bash
git clone https://github.com/kitian616/jekyll-TeXt-theme.git
```
**Clone with SSH:**
```bash
git clone git@github.com:kitian616/jekyll-TeXt-theme.git
```
2. Download and unzip the file to your Jekyll site directory.
<a class="button button--success button--rounded" href="https://github.com/kitian616/jekyll-TeXt-theme/archive/master.zip"><i class="fas fa-download"></i> Download TeXt Theme</a>
3. If you host your site on GitHub Pages, you can just fork [jekyll-TeXt-theme](https://github.com/kitian616/jekyll-TeXt-theme), then rename the repository to **USERNAME.github.io** — replacing **USERNAME** with your GitHub username.
![Fork](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/github-fork.jpg)
![Rename](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/github-rename-repo.jpg)
### Ruby Gem Method
1. Add this line to your Jekyll sites *Gemfile*:
```ruby
gem "jekyll-text-theme"
```
2. Add this line to your Jekyll sites *_config.yml* file:
```yaml
theme: jekyll-text-theme
```
## Setup Your Site
If you install the theme with common method, you can go straight to the next step. But **if you install the theme with ruby gem method, you have to do some extra jobs**.
With gem-based themes, some of the sites directories (such as the *assets*, *_layouts*, *_includes* and *_sass* directories) are stored in the themes gem, hidden from your immediate view. You need add some files in your Jekyll site directory:
```bash
├── 404.html
├── Gemfile
├── _config.yml
├── _data
│   └── locale.yml
├── _posts
│   └── ...
├── about.md
├── archive.html
└── index.html
```
You can refer to the [/test folder](https://github.com/kitian616/jekyll-TeXt-theme/tree/master/test), this is a example with gem-based themes.
## Installing Development Environment
If you want to run them them locally, you need first install Ruby and Jekyll, see [Installation](https://jekyllrb.com/docs/installation/) for details.
After that, run bundler to install the dependencies:
```bash
bundle install --path vendor/bundle
```
And also, TeXt offer [Docker](https://www.docker.com/) support for development and public, this make it easier to setup environment.
![Docker](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/docker.jpg){:width="400px"}
All you need todo is these 3 steps:
1. [Install Docker](https://docs.docker.com/install/).
2. Generate *Gemfile.lock*:
```bash
docker run --rm -v "$PWD":/usr/src/app -w /usr/src/app ruby:2.6 bundle install
```
3. Build Docker image:
```bash
docker-compose -f ./docker/docker-compose.build-image.yml build
```
## Local Preview
Run `bundle exec jekyll serve` to start the development server, then you can visit [http://localhost:4000/](http://localhost:4000/) to preview your site.
For Docker, run `docker-compose -f ./docker/docker-compose.default.yml up` to start the development server.
## Build and Publish
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.

View File

@ -1,52 +0,0 @@
---
title: Structure
permalink: /docs/en/structure
key: docs-structure
---
```bash
├── _data
│ ├── locale.yml
│ ├── navigation.yml
│ └── variables.yml
├── _includes
│ ├── analytics-providers
│ ├── aside
│ ├── comments-providers
│ ├── markdown-enhancements
│ ├── pageview-providers
│ ├── scripts
│ ├── sidebar
│ ├── snippets
│ ├── svg
│ │ ├── icon
│ │ │ ├── social
│ │ │ │ ├── facebook.svg
│ │ │ │ └── ...
│ │ └── logo.svg
│ └── ...
├── _layouts
│ ├── 404.html
│ ├── archive.html
│ ├── article.html
│ ├── base.html
│ ├── home.html
│ ├── none.html
│ └── page.html
├── _sass
├── assets
│ ├── css
│ │ └── blog.scss
│ └── images
├── tools
├── 404.html
├── Gemfile
├── _config.yml
├── about.md
├── archive.html
├── favicon.ico
├── gulpfile.js
├── index.html
├── jekyll-text-theme.gemspec
└── package.json
```

View File

@ -1,215 +0,0 @@
---
title: Update from 1.x to 2.x
permalink: /docs/en/update-from-1-to-2
key: docs-update-from-1-to-2
---
![TeXt 2](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/TeXt-version-2.jpg)
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.
## 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
Post Layout and Page Layout rename to Article Layout.
1.x:
```yml
layout: post
```
```yml
layout: page
```
2.x:
```yml
layout: article
```
Since TOC, Edit on Github button, license and pageview are disabled by default on the new Article Layout, in order to keep same whit the former version, you can add these settings in the Front Matter:
```yml
license: true
aside:
toc: true
show_edit_on_github: true
pageview: true
```
You can also use [Front Matter defaults](https://jekyllrb.com/docs/configuration/#front-matter-defaults) to specify configuration for all the posts of your site:
```yml
defaults:
- scope:
path: ""
type: posts
values:
layout: article
license: true
aside:
toc: true
show_edit_on_github: true
pageview: true
```
### Archive Layout
All Layout rename to Archive Layout.
1.x:
```yml
layout: all
```
2.x:
```yml
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`.
1.x:
```yml
paths:
base : /blog
all : /blog/all.html
rss : /feed.xml
```
2.x:
```yml
paths:
root : /blog
home : /blog
archive : /blog/archive.html
rss : /feed.xml
```
## License
You need to specify `license` in *_config.yml* to enable license, which default to `false`:
```yml
license: CC-BY-4.0
```
## Comments
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.
1.x:
```yml
disqus:
shortname: kitian616-github-io
```
2.x:
```yml
comments:
provider: disqus
disqus:
shortname: kitian616-github-io
```
## Pageview
1.x:
```yml
leancloud:
app_id: uAG3OhdcH8H4fxSqXLyBljA7-gzGzoHsz
app_key: Mzf5m9skSwYVWVXhGiYMNyXs
app_class: ThomasBlog
```
2.x:
```yml
pageview:
provider: leancloud
leancloud:
app_id: uAG3OhdcH8H4fxSqXLyBljA7-gzGzoHsz
app_key: Mzf5m9skSwYVWVXhGiYMNyXs
app_class: ThomasBlog
```
## Analytics
1.x:
```yml
ga_tracking_id: UA-71907556-1
```
2.x:
```yml
analytics:
provider: google
google:
tracking_id: UA-71907556-1
```
## Logo and Favicon
The location of the default logo has changed。the old icon generation tool has been removedTeXt 2 recommend [RealFaviconGenerator](https://realfavicongenerator.net/) for generating favicon.
## Navigator
The navigation configuration at the top right of the site has been moved to *_data/navigation.yml* and the entire navigation is freely customizable in the new version.
1.x:
```yml
nav_lists:
- titles:
en: About
zh: 关于
zh-Hans: 关于
zh-Hant: 關於
url: /blog/about.html
```
2.x:
```yml
## _data/navigation.yml
header:
- titles:
en: Archive
zh: 归档
zh-Hans: 归档
zh-Hant: 歸檔
url: /blog/archive.html
- titles:
en: About
zh: 关于
zh-Hans: 关于
zh-Hant: 關於
url: /blog/about.html
```

View File

@ -1,365 +0,0 @@
---
title: Configuration
permalink: /docs/en/configuration
key: docs-configuration
---
Jekyll allows you to concoct your sites in any way you can dream up, and its thanks to the powerful and flexible configuration options that this is possible. These options can either be specified in a *_config.yml* file placed in your sites root directory, or can be specified as flags for the jekyll executable in the terminal.
For technical reasons, *_config.yml* is **NOT** reloaded automatically when you use `jekyll serve`. If you change this file, please restart the server process.
{:.warning}
<!--more-->
## Site Settings
### Theme
If youre using the Ruby gem version of the theme youll need this line to activate it:
```yaml
theme: jekyll-text-theme
```
### Skin
TeXt has 6 built-in skins, you can also set up your own skin.
| `default` | `dark` | `forest` |
| --- | --- | --- |
| ![Default](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_default.jpg) | ![Dark](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_dark.jpg) | ![Forest](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_forest.jpg) |
| `ocean` | `chocolate` | `orange` |
| --- | --- | --- |
| ![Ocean](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_ocean.jpg) | ![Chocolate](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_chocolate.jpg) | ![Orange](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_orange.jpg) |
```yaml
text_skin: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
```
### Highlight Theme
TeXt use [Tomorrow](https://github.com/chriskempson/tomorrow-theme) as the highlight theme.
| `tomorrow` | `tomorrow-night` | `tomorrow-night-eighties` | `tomorrow-night-blue` | `tomorrow-night-bright` |
| --- | --- | --- | --- | --- |
| ![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) |
Every skin has a default highlight theme, but you can overwrite it by `highlight_theme` variable.
```yaml
highlight_theme: default # "default" (default), "tomorrow", "tomorrow-night", "tomorrow-night-eighties", "tomorrow-night-blue", "tomorrow-night-bright"
```
### URL
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://kitian616.github.io if there is cname file.
Jekyll 3.3 overrides this value with url: http://localhost:4000 when running `jekyll serve` in a development environment[^jekyll_site_variables]. You can specifying Jekyll environment[^jekyll_specifying_environment] to production environment by `JEKYLL_ENV=production` to avoid this behavior.
{:.warning}
[^gitHub_metadata]: [GitHub Metadata, a.k.a. site.github](https://github.com/jekyll/github-metadata#what-it-does)
[^jekyll_site_variables]: [Variables#Site Variables](https://jekyllrb.com/docs/variables/#site-variables)
[^jekyll_specifying_environment]: [Configuration#Specifying a Jekyll environment at build timePermalink](https://jekyllrb.com/docs/configuration/#specifying-a-jekyll-environment-at-build-time)
### Base URL
The base URL for your site, default to '/'. If you are hosting the site on Github Pages this will be set as the project name for project pages if none is set[^gitHub_metadata].
### Title
The name of your site.
```yaml
title: "My Awesome Website"
```
### Description
Use some words to describe your site.
```yaml
description: > # this means to ignore newlines until "nav_lists:"
A website with awesome stories.
```
## Language and Timezone
### Language
The language of your site, you can override it with different ones on specific posts, pages by YAML Front Matter[^font_matter], learn more at [Internationalization](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/i18n).
```yaml
lang: en
```
[^font_matter]: [Front Matter](https://jekyllrb.com/docs/frontmatter/)
### Timezone
Set the time zone for site generation. This sets the TZ environment variable, which Ruby uses to handle time and date creation and manipulation. A list of all available values can be found [HERE](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
When serving on a local machine, the default time zone is set by your operating system. But when served on a remote host/server, the default time zone depends on the servers setting or location.[^jekyll_global_configuration]
[^jekyll_global_configuration]: [Configuration#Global Configuration](https://jekyllrb.com/docs/configuration/#global-configuration)
```yaml
timezone: Asia/Shanghai
```
## Author and Social
Information of the site author (a person, a team or an organization).
### Type
Type of the site author, a person or an organization, used by [schema.org](https://schema.org/) markup, default as "person".
### Name
Used to assign a site author.
### Avatar
Photo or Logo for site author
### Bio
Short introduction for site author
### Social
Username or id of site authors social networks.
TeXt supports Email, Facebook, Twitter, Weibo, Google Plus, Telegram, Medium, Zhihu, Douban, Linkedin, Github and Npm, more to be added.
Depending on your settings, the social network buttons would show on every pages' footer.
## GitHub repository
Setting for [GitHub Metadata](https://github.com/jekyll/github-metadata) plugin, you can refer to [HERE](https://github.com/jekyll/github-metadata/blob/master/docs/configuration.md#configuration) for more info.
In order for jekyll-github-metadata to know what metadata to fetch it must be able to determine the repository NWO to ask GitHub about.
“NWO” stands for “name with owner.” It is GitHub lingo for the username of the owner of the repository plus a forward slash plus the name of the repository, e.g. kitian616/jekyll-TeXt-theme, where “kitian616” is the owner and “jekyll-TeXt-theme” is the repository name.
```yaml
repository: user_name/repo_name
```
## Post
### Excerpt
Each post automatically takes the first block of text, from the beginning of the content to the first occurrence of `excerpt_separator`, and sets it as the posts excerpt.
The posts excerpt is show in the articles list in the home layout. There are two excerpt types, text type and html type.
| Type Name | Description |
| --- | --- |
| **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** | 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 [HERE](https://jekyllrb.com/docs/posts/#post-excerpts). |
```yaml
excerpt_separator: <!--more-->
excerpt_type: text # text (default), html
```
This setting has been **MOVED** to the YAML Front Matter of Articles and home layout **Since Version 2.2.0**, You can find more information [HERE](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/layouts#articles-layout).
{:.error}
### License
| Name | License | Image |
| --- | --- | --- |
| CC-BY-4.0 | [Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) | ![CC-BY-4.0](https://i.creativecommons.org/l/by/4.0/88x31.png) |
| CC-BY-SA-4.0 | [Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/) | ![CC-BY-SA-4.0](https://i.creativecommons.org/l/by-sa/4.0/88x31.png) |
| CC-BY-NC-4.0 | [Attribution-NonCommercial 4.0 International](https://creativecommons.org/licenses/by-nc/4.0/) | ![CC-BY-NC-4.0](https://i.creativecommons.org/l/by-nc/4.0/88x31.png) |
| CC-BY-ND-4.0 | [Attribution-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nd/4.0/) | ![CC-BY-ND-4.0](https://i.creativecommons.org/l/by-nd/4.0/88x31.png) |
```yaml
license: CC-BY-NC-4.0
```
### TOC
Elements to use as headings.
```yaml
toc:
selectors: "h1,h2,h3"
```
### Markdown Enhancements
To improve the user experience for both reading and writing posts, TeXt made some enhancements for markdown. By default, all the enhancements for markdown is enabled. you need set the settings to true to enable them:
```yaml
# Mathjax
mathjax: true
mathjax_autoNumber: true
# Mermaid
mermaid: true
# Chart
chart: true
```
And also you can override it with different ones on specific posts, pages by YAML Front Matter[^font_matter].
Check [Writing Posts](/) for detail usage.
## Paginate
Settings for [Jekyll Paginate](https://github.com/jekyll/jekyll-paginate) plugin. to enable pagination for posts on your blog, add a line to the *_config.yml* file that specifies how many items should be displayed per page:
```yaml
paginate: 8
```
The number should be the maximum number of posts youd like to be displayed per-page in the generated site.
You may also specify the destination of the pagination pages:
```yaml
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 sites CDN provider, both of them are open source and free.
If your website is mainly for Chinese, just use BootCDN.
```yaml
sources: bootcdn # bootcdn (default), unpkg
```
[^cdn]: [Content delivery network](https://en.wikipedia.org/wiki/Content_delivery_network)
## Sharing
| Name | Sharing Provider | Minimum Version |
| --- | --- | --- |
| **addtoany** | [AddToAny](https://www.addtoany.com/) | 2.2.2 |
| **addthis** | [AddThis](https://www.addthis.com/) | 2.2.3 |
| **custom** | | |
### AddToAny
```yaml
comments:
provider: addtoany
```
### AddThis
```yaml
comments:
provider: addthis
addthis:
id: "your-addthis-pubid"
```
You NEED set `sharing` variable as `true` in the pages YAML Front Matter to enable sharing on this page, you can find more information [HERE](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/layouts#article-layout).
{:.warning}
## Comments
| Name | Comments Provider | Minimum Version |
| --- | --- | --- |
| **disqus** | [Disqus](https://disqus.com/) | |
| **gitalk** | [Gitalk](https://github.com/gitalk/gitalk/) | |
| **valine** | [Valine](https://valine.js.org/en/) | 2.2.4 |
| **custom** | | |
### Disqus
To use Disqus youll need to create an account and [shortname](https://help.disqus.com/customer/portal/articles/466208-what-s-a-shortname-). Once you have both update *_config.yml* to:
```yaml
comments:
provider: disqus
disqus:
shortname: "your-disqus-shortname"
```
### Gitalk
To use Gitalk you need a GitHub application, if you don't have one, [Click here to register](https://github.com/settings/applications/new) a new one. and then update *_config.yml* to:
```yaml
comments:
provider: gitalk
gitalk:
clientID : "github-application-client-id"
clientSecret: "github-application-client-secret"
repository : "github-repo"
owner : "github-repo-owner"
admin: # Github repo owner and collaborators, only these guys can initialize github issues, IT IS A LIST.
- "your-github-id"
- "the-other-admin-github-id"
```
### Valine
To use Valine you need a [LeanCloud](https://leancloud.cn/) application, see [LeanCloud](#leancloud) for more information.
```yaml
comments:
provider: valine
valine:
app_id : "your-leanCloud-app-id"
app_key : "your-leanCloud-app-key"
```
For all the above comments systems, you NEED set `key` variable in the pages YAML Front Matter to enable comments on this page, you can find more information [HERE](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/layouts#page-layout).
{:.warning}
## Pageview
| Name | Pageview Provider |
| --- | --- |
| **leancloud** | [LeanCloud](https://leancloud.cn/) |
| **custom** | |
### LeanCloud
This use [LeanCloud](https://leancloud.cn/) as back-end service. You need create an application on the dashboard, and config the apps id, key and class name.
The detail guide of LeanCloud will find in [Chinese document](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/configuration#leancloud) since LeanCloud haven't provide an English-language edition.
{:.info}
```yaml
pageview:
provider: leancloud
leancloud:
app_id : "your-leanCloud-app-id"
app_key : "your-leanCloud-app-key"
app_class : "your-leanCloud-app-class"
```
For all the above pageview statistics, you **NEED** set `key` variable in the pages YAML Front Matter to enable statistics on this page, you can find more information [HERE](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/layouts#page-layout).
{:.warning}
## Analytics
| Name | Analytics Provider |
| --- | --- |
| **google** | [Google Analytics](https://analytics.google.com/) |
| **custom** | |
### Google Analytics
In order to use Google Analytics, set `tracking_id` to your Google Analytics tracking code. You can also set `anonymize_ip` to `true` to anonymize IP tracking for analytic.
```yaml
analytics:
provider: google
google:
tracking_id: "your-google-analytics-tracking-code"
anonymize_ip: true
```

View File

@ -1,66 +0,0 @@
---
title: Navigation
permalink: /docs/en/navigation
key: docs-navigation
---
There are two types of navigation in TeXt: **Header Navigation** and **Sidebar Navigation**, both are defined in *data/navigation.yml*.
<!--more-->
## Header Navigation
Header navigation is defined under the `header` key in *data/navigation.yml*, it is an array of title(s) and url:
```yaml
header:
- title: Docs
url: /docs/en/quick-start
- title: 文档
url: /docs/zh/quick-start
- titles:
en: Archive
zh: 归档
zh-Hans: 归档
zh-Hant: 歸檔
url: /archive.html
- titles:
en: About
zh: 关于
zh-Hans: 关于
zh-Hant: 關於
url: /about.html
- title: GitHub
url: https://github.com/kitian616/jekyll-TeXt-theme
```
You can use `titles` for a multi-language name.
## Sidebar Navigation
To use sidebar navigation, you should first define a navigation in *data/navigation.yml*.
```yaml
docs-en:
- title: Start
children:
- title: Quick Start
url: /docs/en/quick-start
- title: Structure
url: /docs/en/structure
...
- title: Customization
children:
- title: Configuration
url: /docs/en/configuration
- title: Navigation
url: /docs/en/navigation
...
```
And then use the defined navigation as articles sidebar navigation in the Front Matter:
```yaml
sidebar:
nav: docs-en
```

View File

@ -1,178 +0,0 @@
---
title: Layout
permalink: /docs/en/layouts
key: docs-layouts
---
```mermaid
graph TB;
NONE[none]
BASE[base]
PAGE[page]
ARTICLE[article]
ARTICLES[articles]
HOME[home]
ARCHIVE[archive]
LANDING[landing]
404[404]
NONE-->BASE;
BASE-->PAGE;
PAGE-->ARTICLE;
PAGE-->ARTICLES;
ARTICLES-->HOME;
PAGE-->ARCHIVE;
PAGE-->LANDING;
PAGE-->404;
```
## Base Layout
Base on None.
## Page Layout
Base on Base Layout.
| Variable | Option Values | Description | Minimum Version |
| --- | --- | --- | --- |
| **mode** | normal (default), immersive | mode of the page. | 2.2.0 |
| **type** | webpage (default), article | type of the page, used by [schema.org](https://schema.org/) markup. | |
| **key** | `!!str` | Unique key for the post, required by Comments and Pageview. begin with a letter (`[A-Za-z]`) and may be followed by any number of letters, digits (`[0-9]`), hyphens (`-`), underscores (`_`), colons (`:`), and periods (`.`). | |
| **lang** | en (default), zh, zh-Hans, zh-Hant | Language of this page. | |
| **author** | `!!map` | Assign one of the authors in *authors.yml* to a post or page, see [Authors](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/authors) for detail. | 2.2.0 |
| **show_title** | true (default), false | Set as `false` to hide title on this page. | |
| **show_edit_on_github** | true, false (default) | Set as `true` to show “Edit on Github” button. you need set `repository` and `repository_tree` in *_config.yml* first. | |
| **show_date** | true (default), false | Set as `false` to hide date on this page. | 2.2.0 |
| **show_tags** | true (default), false | Set as `false` to hide tags on this page. | 2.2.0 |
| **full_width** | true, false (default) | Set as `true` to make main full width on this page. | |
| **pageview** | true, false (default) | Set as `true` to enable pageview on this page. | 2.2.0 |
| **comment** | true (default), false | Set as `false` to disable comment on this page. | |
| **mathjax** | true, false | Set as `true` to enable Mathjax on this page. | |
| **mathjax_autoNumber** | true, false | Set as `true` to enable Mathjax autoNumber on this page. | |
| **mermaid** | true, false | Set as `true` to enable Mermaid on this page. | |
| **chart** | true, false | Set as `true` to enable Chart on this page. | |
| **cover** | `!!str` | Url of the cover image. | 2.2.0 |
| **header** | false, `!!map` | Set as `false` to hide header on this page. | 2.2.0 |
| **article_header**| `!!map` | | 2.2.0 |
| **aside** | `!!map` | | |
| **sidebar** | `!!map` | | |
| **footer** | false | Set as `false` to hide footer on this page. | 2.2.3 |
| **lightbox** | true, false | Set as `true` to enable lightbox (modal image gallery) for large images on this page, you can set `lightbox-ignore` class name to ignore the certain image. | 2.2.4 |
### header
| Variable | Option Values | Description |
| --- | --- | --- |
| **theme** | light, dark | |
| **background** | `!!str` | Available when specified theme. |
### article_header
| Variable | Option Values | Description |
| --- | --- | --- |
| **type** | overlay, cover | |
| **align** | left (default), center| |
| **theme** | light (default), dark | |
| **background_color** | `!!str` | Available when type is `overlay`. If set to a dark color, you need set theme as 'dark'. |
| **background_image** | `!!map` | Available when type is `overlay`, set as `false` can overwrite `cover` to disable background image. |
| **image** | `!!map` | Available when type is `cover`. |
| **actions** | `!!seq` | |
### article_header.background_image
| Variable | Option Values | Description |
| --- | --- | --- |
| **gradient** | `!!str` | |
| **src** | `!!str` | Default to `cover` |
### article_header.image
| Variable | Option Values | Description |
| --- | --- | --- |
| **src** | `!!str` | |
### aside
| Variable | Option Values | Description |
| --- | --- | --- |
| **toc** | true, false | Set as `true` to enable TOC on this page's aside. |
### sidebar
| Variable | Option Values | Description |
| --- | --- | --- |
| **nav** | `!!str` | |
## Article Layout
Base on Page Layout.
| Variable | Option Values | Description | Minimum Version |
| --- | --- | --- | --- |
| **modify_date** | `!!str` | The last modified date of this article, the date is modified in the format `YYYY-MM-DD HH:MM:SS +/-TTTT`; hours, minutes, seconds, and timezone offset are optional. just like `date` variable. | |
| **sharing** | true, false (default) | Set as `true` to enable Sharing on this article. | 2.2.2 |
| **show_author_profile** | true, false (default) | Set as `true` to show author profile at the beginning of the article. | |
| **show_subscribe**| true, false (default) | Set as `true` to show subscribe info on this page. | latest |
| **license** | true, false (default), CC-BY-4.0, CC-BY-SA-4.0, CC-BY-NC-4.0, CC-BY-ND-4.0 | license of the article. Set true to use `license` variable that set in *_config.yml*, set false to enable it. | |
## Articles Layout
Base on Page Layout, available since version **2.2.0**.
| Variable | Option Values | Description |
| --- | --- | --- |
| **articles** | `!!map` | |
### articles
| Variable | Option Values | Description |
| --- | --- | --- |
| **data_source** | `!!str` | You can set it as a collections name, then the page will show the article list of this collections. You can refer to [Collections](https://jekyllrb.com/docs/collections/) to learn more about collections. |
| **type** | item, brief, grid | TeXt supports 3 article list type with various settings, yan can find examples [HERE](https://kitian616.github.io/jekyll-TeXt-theme/samples.html#articles-layout). |
| **size** | md, sm | Available when type is `grid`. |
| **article_type** | BlogPosting | Available when type is `normal`. |
| **show_cover** | true (default), false | Available when type is `normal`. Before set it to `true`, you need first set each article a cover image, refer to the `cover` variable in [Page Layout](#page-layout). |
| **cover_size** | lg, md, sm | Available when type is `normal`. |
| **show_excerpt** | true, false (default) | Available when type is `normal`, refer to [excerpt_type](#excerpt_type) below. |
| **excerpt_type** | text, html | Available when type is `normal`. |
| **show_readmore** | true, false (default) | Available when type is `normal`. |
| **show_info** | true, false (default) | Available when type is `normal` or `brief`. |
### articles.excerpt_type
Each post automatically takes the first block of text, from the beginning of the content to the first occurrence of `excerpt_separator`, and sets it as the posts excerpt.
The excerpt is show in the article list in the Articles and Home Layout. There are two excerpt types, text type and html type.
| Type Name | Description |
| --- | --- |
| **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** | 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 [HERE](https://jekyllrb.com/docs/posts/#post-excerpts). |
For the home page, you can set `excerpt_type` to `HTML` like this:
```yaml
layout: home
articles:
excerpt_type: html
```
## Home Layout
Base on Articles Layout.
## Archive Layout
Base on Page Layout.
## Landing Layout
Base on Page Layout.
| Variable | Option Values | Description |
| --- | --- | --- |
| **data** | `!!map` | |
## 404 Layout
Base on Page Layout.

View File

@ -1,30 +0,0 @@
---
title: Logo and Favicon
permalink: /docs/en/logo-and-favicon
key: docs-logo-and-favicon
---
## Logo
<p>TeXt <span>{% include svg/logo.svg %}</span> as logo, you can change it by replacing <em>_includes/svg/logo.svg</em> with your own logo.</p>
## Favicon
TeXt recommend [RealFaviconGenerator](https://realfavicongenerator.net/) for generating favicon.
Open [RealFaviconGenerator](https://realfavicongenerator.net/), click “Select your Favicon picture” and then choose your favicon picture.
![Select your Favicon picture](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/realfavicongenerator-select-favicon-picture.jpg)
After settings you need tell the generator where you would place favicon files, TeXt default put them to */assets*.
Its recommended to put favicon files at the root of your site.
{:.warning}
![Select your Favicon path](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/realfavicongenerator-path.jpg)
If all are done, just click “Generate your Favicons and HTML code” to the last step.
![Result](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/realfavicongenerator-result.jpg)
Download favicon package and unzip it to the path you just set, and replace the HTML code in *_includes/head/favicon.html*.

View File

@ -1,34 +0,0 @@
---
title: Authors
permalink: /docs/en/authors
key: docs-authors
---
By default all the posts or pages are authored by `author` that configured in *_config.yml*, but you can overwrite it in the pages YAML Front Mater.
Todo so, you need create *_data/authors.yml* and add authors using the following format. Any variables found under `author` in *_config.yml* can be used (type, name, url, avatar, bio, email, facebook etc.).
```yml
Tian Qi:
name : Tian Qi
url : https://kitian616.github.io
avatar : https://wx3.sinaimg.cn/large/73bd9e13ly1fjkqy66hl8j208c08c0td.jpg
bio : Author of TeXt.
email : kitian616@outlook.com
facebook : # "user_name" the last part of your profile url, e.g. https://www.facebook.com/user_name
twitter : kitian616 # "user_name" the last part of your profile url, e.g. https://twitter.com/user_name
weibo : 234695683 # "user_id" the last part of your profile url, e.g. https://www.weibo.com/user_id/profile?...
googleplus: 101827554735084402671 # "user_id" the last part of your profile url, e.g. https://plus.google.com/u/0/user_id
telegram : # "user_name" the last part of your profile url, e.g. https://t.me/user_name
medium : # "user_name" the last part of your profile url, e.g. https://medium.com/user_name
zhihu : # "user_name" the last part of your profile url, e.g. https://www.zhihu.com/people/user_name
douban : # "user_name" the last part of your profile url, e.g. https://www.douban.com/people/user_name
linkedin : # "user_name" the last part of your profile url, e.g. https://www.linkedin.com/in/user_name
github : kitian616 # "user_name" the last part of your profile url, e.g. https://github.com/user_name
npm : # "user_name" the last part of your profile url, e.g. https://www.npmjs.com/~user_name
```
Assign one of the authors in *authors.yml* to a post or page you wish to override the `site.author` with.
---
author: Tian Qi
---

View File

@ -1,26 +0,0 @@
---
title: Internationalization
permalink: /docs/en/i18n
key: docs-i18n
---
Text for UI elements are grouped together as a set of translation keys in *_data/locale.yml*, this make TeXt easy to support different languages.
By using `titles`, you can define multi-language name for page, layout and navigator title. TeXt default defined some multi-language name in *_data/navigation*, *_layouts/archive*, *_layouts/home* and *about.md*.
<!-- more -->
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 |
| **Turkish** | tr |
<!-- @end locale config -->
You can see examples for different languages [HERE](https://kitian616.github.io/jekyll-TeXt-theme/samples.html#languages).

View File

@ -1,34 +0,0 @@
---
title: Writing Posts
permalink: /docs/en/writing-posts
key: docs-writing-posts
---
As explained on the [directory structure](https://jekyllrb.com/docs/structure/) page, **the */_posts* folder is where your blog posts will live**. These files are generally Markdown or HTML. All posts must have YAML Front Matter, and they will be converted from their source format into an HTML page that is part of your static site.
<!--more-->
## Creating Post Files
To create a new post, all you need to do is create a file in the */_posts* directory. Jekyll requires blog post files to be named like these:
2011-12-31-new-years-eve-is-awesome.md
2012-09-12-how-to-write-a-blog.markdown
## Content
All blog post files must begin with YAML Front Matter.
To improve the user experience for both reading and writing posts, TeXt made some enhancements for markdown and some additional styles.
### YAML Front Matter
---
layout: article
title: Document - Writing Posts
mathjax: true
---
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 Jekylls predefined variables, TeXt define some new variables for each layouts, see [Layouts](https://kitian616.github.io/jekyll-TeXt-theme/docs/en/layouts) for details.

View File

@ -1,171 +0,0 @@
---
title: Markdown Enhancements
permalink: /docs/en/markdown-enhancements
key: docs-markdown-enhancements
---
You need set the variable true in the *_config.yml* or in the YAML Front Matter to enable markdown enhancement.
| Enhancemen Name | Description |
| --------------- | ----------- |
| **Mathjax** | Make it easy to add mathematics in articles, using MathML, LaTeX and ASCIIMathML markup | [EXAMPLES](https://kitian616.github.io/jekyll-TeXt-theme/post/2017/07/07/mathjax.html) |
| **Mermaid** | Bring diagrams and flowcharts in articles | [EXAMPLES](https://kitian616.github.io/jekyll-TeXt-theme/post/2017/06/06/mermaid.html) |
| **Chart** | Bring charts in articles | [EXAMPLES](https://kitian616.github.io/jekyll-TeXt-theme/post/2017/05/05/chart.html) |
## Mathjax
When $$a \ne 0$$, there are two solutions to $$ax^2 + bx + c = 0$$ and they are
$$x_1 = {-b + \sqrt{b^2-4ac} \over 2a}$$
$$x_2 = {-b - \sqrt{b^2-4ac} \over 2a} \notag$$
**markdown:**
```tex
When $$a \ne 0$$, there are two solutions to $$ax^2 + bx + c = 0$$ and they are
$$x_1 = {-b + \sqrt{b^2-4ac} \over 2a}$$
$$x_2 = {-b - \sqrt{b^2-4ac} \over 2a} \notag$$
```
**After MathJax enabled**, you can set `mathjax_autoNumber: true` to have equations be numbered automatically, You can use \notag or \nonumber to prevent individual equations from being numbered.
{:.info}
## Mermaid
```mermaid
graph TB;
A[Do you have a problem in your life?]
B[Then don't worry]
C[Can you do something about it?]
A--no-->B;
A--yes-->C;
C--no-->B;
C--yes-->B;
```
**markdown:**
```mermaid
graph TB;
A[Do you have a problem in your life?]
B[Then don't worry]
C[Can you do something about it?]
A--no-->B;
A--yes-->C;
C--no-->B;
C--yes-->B;
```
[Mermaid](https://mermaidjs.github.io/) supports 3 kinds of diagram:
- [Flowchart](https://mermaidjs.github.io/flowchart.html)
- [Sequence Diagram](https://mermaidjs.github.io/sequenceDiagram.html)
- [Gant Diagram](https://mermaidjs.github.io/gantt.html)
## Chart
```chart
{
"type": "line",
"data": {
"labels": [
"January",
"February",
"March",
"April",
"May",
"June",
"July"
],
"datasets": [
{
"label": "# of bugs",
"fill": false,
"lineTension": 0.1,
"backgroundColor": "rgba(75,192,192,0.4)",
"borderColor": "rgba(75,192,192,1)",
"borderCapStyle": "butt",
"borderDash": [],
"borderDashOffset": 0,
"borderJoinStyle": "miter",
"pointBorderColor": "rgba(75,192,192,1)",
"pointBackgroundColor": "#fff",
"pointBorderWidth": 1,
"pointHoverRadius": 5,
"pointHoverBackgroundColor": "rgba(75,192,192,1)",
"pointHoverBorderColor": "rgba(220,220,220,1)",
"pointHoverBorderWidth": 2,
"pointRadius": 1,
"pointHitRadius": 10,
"data": [
65,
59,
80,
81,
56,
55,
40
],
"spanGaps": false
}
]
},
"options": {}
}
```
**markdown:**
```chart
{
"type": "polarArea",
"data": {
"datasets": [
{
"data": [
11,
16,
7,
3,
14
],
"backgroundColor": [
"#FF6384",
"#4BC0C0",
"#FFCE56",
"#E7E9ED",
"#36A2EB"
],
"label": "My dataset"
}
],
"labels": [
"Red",
"Green",
"Yellow",
"Grey",
"Blue"
]
},
"options": {}
}
```
[Chart.js](http://www.chartjs.org/docs/latest/) supports 7 kinds of chart:
- [Line Chart](http://www.chartjs.org/docs/latest/charts/line.html)
- [Bar Chart](http://www.chartjs.org/docs/latest/charts/bar.html)
- [Radar Chart](http://www.chartjs.org/docs/latest/charts/radar.html)
- [Polar Area Chart](http://www.chartjs.org/latest/charts/polar.html)
- [Pie Chart](http://www.chartjs.org/docs/latest/charts/doughnut.html)
- [Doughnut Chart](http://www.chartjs.org/docs/latest/charts/doughnut.html)
- [Bubble Chart](http://www.chartjs.org/docs/latest/charts/bubble.html)

View File

@ -1,169 +0,0 @@
---
title: Additional styles
permalink: /docs/en/additional-styles
key: docs-additional-styles
---
Jekyll use kramdown as the default markdown processor. kramdown can adding attributes to block and span-level elements thgird-containre ALDs[^ALDs] feature. with the help of ALDs, we can defined class names to an element by `{:.class-name1.class-name-2}`.
TeXt offer some CSS classes that you can use in the post. You can refer to [THIS POST](https://kitian616.github.io/jekyll-TeXt-theme/post/2017/08/08/additional-styles.html).
[^ALDs]: [Attribute List Definitions](https://kramdown.gettalong.org/syntax.html#attribute-list-definitions)
## Alert
| Class Names |
| ---- |
| **success** |
| **info** |
| **warning** |
| **error** |
Success Text.
{:.success}
Info Text.
{:.info}
Warning Text.
{:.warning}
Error Text.
{:.error}
**markdown:**
Success Text.
{:.success}
^
Info Text.
{:.info}
^
Warning Text.
{:.warning}
^
Error Text.
{:.error}
## Tag
| Class Names |
| ---- |
| **success** |
| **info** |
| **warning** |
| **error** |
`success`{:.success}
`info`{:.info}
`warning`{:.warning}
`error`{:.error}
**markdown:**
`success`{:.success}
^
`info`{:.info}
^
`warning`{:.warning}
^
`error`{:.error}
## Image
| Class Names |
| ---- |
| **border** |
| **shadow** |
| **rounded** |
| **circle** |
### Border
<div class="grid-containre">
<div class="grid grid--p-2">
<div class="cell cell--12 cell--md-4 " markdown="1">
![Image](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg "Image_border"){:.border}
</div>
<div class="cell cell--12 cell--md-auto" markdown="1">
![Image](path-to-image){:.border}
</div>
</div>
</div>
### Shadow
<div class="grid-containre">
<div class="grid grid--p-2">
<div class="cell cell--12 cell--md-4 " markdown="1">
![Image](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg "Image_shadow"){:.shadow}
</div>
<div class="cell cell--12 cell--md-auto" markdown="1">
![Image](path-to-image){:.shadow}
</div>
</div>
</div>
### Rounded
<div class="grid-containre">
<div class="grid grid--p-2">
<div class="cell cell--12 cell--md-4 " markdown="1">
![Image](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg "Image_rounded"){:.rounded}
</div>
<div class="cell cell--12 cell--md-auto" markdown="1">
![Image](path-to-image){:.rounded}
</div>
</div>
</div>
### Circle
<div class="grid-containre">
<div class="grid grid--p-2">
<div class="cell cell--12 cell--md-4 " markdown="1">
![Image](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg "Image_circle"){:.circle}
</div>
<div class="cell cell--12 cell--md-auto" markdown="1">
![Image](path-to-image){:.circle}
</div>
</div>
</div>
### Mixture
<div class="grid-containre">
<div class="grid grid--p-2">
<div class="cell cell--12 cell--md-4 " markdown="1">
![Image](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg "Image_border+rounded"){:.border.rounded}
</div>
<div class="cell cell--12 cell--md-auto" markdown="1">
![Image](path-to-image){:.border.rounded}
</div>
</div>
</div>
<div class="grid-containre">
<div class="grid grid--p-2">
<div class="cell cell--12 cell--md-4 " markdown="1">
![Image](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg "Image_circle+shadow"){:.circle.shadow}
</div>
<div class="cell cell--12 cell--md-auto" markdown="1">
![Image](path-to-image){:.circle.shadow}
</div>
</div>
</div>
<div class="grid-containre">
<div class="grid grid--p-2">
<div class="cell cell--12 cell--md-4 " markdown="1">
![Image](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg "Image_circle+border+shadow"){:.circle.border.shadow}
</div>
<div class="cell cell--12 cell--md-auto" markdown="1">
![Image](path-to-image){:.circle.border.shadow}
</div>
</div>
</div>

View File

@ -1,174 +0,0 @@
---
title: Extensions
permalink: /docs/en/extensions
key: docs-extensions
---
## Audio
| Name | Minimum Version |
| --- | --- |
| SoundCloud | 2.2.2 |
| Netease Cloud Music | 2.2.2 |
### SoundCloud
**id:**
![extensions-soundcloud](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/extensions-soundclound.jpg){:style="max-height:500px"}{:.border}
**html:**
{% raw %}
```html
{%- include extensions/soundcloud.html id='313627932' -%}
```
**markdown:**
```
<div>{%- include extensions/soundcloud.html id='313627932' -%}</div>
```
{% endraw %}
### Netease Cloud Music (网易云音乐)
Available in Chinese mainland.
**id:**
![extensions-soundcloud](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/extensions-netease-cloud-music.jpg){:style="max-height:320px"}{:.border}
**html:**
{% raw %}
```html
{%- include extensions/netease-cloud-music.html id='413812448' -%}
```
**markdown:**
```
<div>{%- include extensions/netease-cloud-music.html id='413812448' -%}</div>
```
{% endraw %}
## Video
| Name | Minimum Version |
| --- | --- |
| YouTube | 2.2.2 |
| TED | 2.2.2 |
| bilibili | 2.2.2 |
### YouTube
**id:**
![extensions-soundcloud](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/extensions-youtube.jpg){:style="max-height:250px"}{:.border}
**html:**
{% raw %}
```html
{%- include extensions/youtube.html id='wbY97-hdD5c' -%}
```
**markdown:**
```
<div>{%- include extensions/youtube.html id='wbY97-hdD5c' -%}</div>
```
{% endraw %}
### TED
**id:**
![extensions-soundcloud](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/extensions-ted.jpg){:style="max-height:83px"}{:.border}
**html:**
{% raw %}
```html
{%- include extensions/ted.html id='emily_esfahani_smith_there_s_more_to_life_than_being_happy' -%}
```
**markdown:**
```
<div>{%- include extensions/ted.html id='emily_esfahani_smith_there_s_more_to_life_than_being_happy' -%}</div>
```
{% endraw %}
### bilibili (哔哩哔哩)
**id:**
![extensions-bilibili](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/extensions-bilibili.jpg){:style="max-height:190px"}{:.border}
**html:**
{% raw %}
```html
{%- include extensions/bilibili.html id='11091080' -%}
```
**markdown:**
```
<div>{%- include extensions/bilibili.html id='11091080' -%}</div>
```
{% endraw %}
## Slide
| Name | Minimum Version |
| --- | --- |
| SlideShare | 2.2.2 |
### SlideShare
**id:**
![extensions-slideshare](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/extensions-slideshare.jpg){:style="max-height:480px"}{:.border}
**html:**
{% raw %}
```html
{%- include extensions/slideshare.html id='u9L9zDsqEWNKE1' -%}
```
**markdown:**
```
<div>{%- include extensions/slideshare.html id='u9L9zDsqEWNKE1' -%}</div>
```
{% endraw %}
## Demos
| Name | Minimum Version |
| --- | --- |
| CodePen | 2.2.3 |
### CodePen
**user & hash:**
![extensions-codepen](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/extensions-codepen.jpg){:style="max-height:100px"}{:.border}
**html:**
{% raw %}
```html
{%- include extensions/codepen.html user='kitian616' hash='aQmWZG' default_tab='html,result' -%}
```
**markdown:**
```
<div>{%- include extensions/codepen.html user='kitian616' hash='aQmWZG' default_tab='html,result' -%}</div>
```
{% endraw %}

View File

@ -1,52 +0,0 @@
---
title: Spacing
permalink: /docs/en/spacing
key: docs-spacing
---
Spacing classes are named using the format `{property}{side}-{spacer}`.
Where *property* is one of:
- `m` - for classes that set `margin`
- `p` - for classes that set `padding`
Where *side* is one of:
- `t` - for classes that set `margin-top` or `padding-top`
- `b` - for classes that set `margin-bottom` or `padding-bottom`
- `l` - for classes that set `margin-left` or `padding-left`
- `r` - for classes that set `margin-right` or `padding-right`
- `x` - for classes that set both `*-left` and `*-right`
- `y` - for classes that set both `*-top` and `*-bottom`
blank - for classes that set a `margin` or `padding` on all 4 sides of the element
Where *spacer* is one of:
- 0 - for classes that eliminate the `margin` or `padding` by setting it to `0`
- 1 - for classes that set the `margin` or `padding` to `$spacer * .25`
- 2 - for classes that set the `margin` or `padding` to `$spacer * .5`
- 3 - for classes that set the `margin` or `padding` to `$spacer`
- 4 - for classes that set the `margin` or `padding` to `$spacer * 1.5`
- 5 - for classes that set the `margin` or `padding` to `$spacer * 3`
- auto - for classes that set the `margin` to `auto`
`$spacer` is default to `1rem`, you can change or add new entries to the `$spacers` Sass map variable.
## Examples
```html
<div class="mt-2"></div>
<div style="margin-top: ($spacer * .5)"></div>
```
```html
<div class="mx-3"></div>
<div class="margin-left: $spacer; margin-right: $spacer;"></div>
```
```html
<div class="p-4"></div>
<div class="padding: ($spacer * 1.5);"></div>
```

View File

@ -1,209 +0,0 @@
---
title: Grid
permalink: /docs/en/grid
key: docs-grid
---
<style>
.grid-example {
background-color: rgba(37, 147, 252, .28);
}
.content {
padding: 5px 0;
overflow: auto;
color: #fff;
word-wrap: normal;
background-color: #2593fc;
border: 1px rgba(0, 0, 0, .4) solid;
}
.content--auto {
background-color: #ff69b4;
}
</style>
## Base
<div class="grid-example my-5">
<div class="grid">
<div class="cell cell--6 content">6 cells</div>
<div class="cell cell--2 content">2 cells</div>
<div class="cell cell--4 content">4 cells</div>
</div>
</div>
```html
<div class="grid">
<div class="cell cell--6">6 cells</div>
<div class="cell cell--2">2 cells</div>
<div class="cell cell--4">4 cells</div>
</div>
```
## Responsive
<div class="grid-example my-5">
<div class="grid">
<div class="cell cell--12 cell--lg-6 content">12/12/6 cells</div>
<div class="cell cell--12 cell--md-4 cell--lg-2 content">12/4/2 cells</div>
<div class="cell cell--12 cell--md-8 cell--lg-4 content">12/8/4 cells</div>
</div>
</div>
```html
<div class="grid">
<div class="cell cell--12 cell--lg-6 content">12/12/6 cells</div>
<div class="cell cell--12 cell--md-4 cell--lg-2 content">12/4/2 cells</div>
<div class="cell cell--12 cell--md-8 cell--lg-4 content">12/8/4 cells</div>
</div>
```
## Auto Sizing
<div class="grid-example my-5">
<div class="grid">
<div class="cell cell--2 content">2 cells</div>
<div class="cell cell--auto content content--auto">Whatever's left!</div>
</div>
</div>
```html
<div class="grid">
<div class="cell cell--2">2 cells</div>
<div class="cell cell--auto">whatever's left!</div>
</div>
```
<div class="grid-example my-5">
<div class="grid">
<div class="cell cell--shrink content">shrink</div>
<div class="cell cell--auto content content--auto">expand</div>
</div>
</div>
```html
<div class="grid">
<div class="cell cell--shrink">shrink</div>
<div class="cell cell--auto">expand</div>
</div>
```
## Gutters
<div class="grid-container my-5 grid-example">
<div class="grid grid--p-3">
<div class="cell cell--6">
<div class="content">6 cells</div>
</div>
<div class="cell cell--6">
<div class="content">6 cells</div>
</div>
<div class="cell cell--6">
<div class="content">6 cells</div>
</div>
<div class="cell cell--6">
<div class="content">6 cells</div>
</div>
</div>
</div>
```html
<div class="grid-container">
<div class="grid grid--p-3">
<div class="cell cell--6"><div>6 cells</div></div>
<div class="cell cell--6"><div>6 cells</div></div>
<div class="cell cell--6"><div>6 cells</div></div>
<div class="cell cell--6"><div>6 cells</div></div>
</div>
</div>
```
<div class="grid-container my-5 grid-example">
<div class="grid grid--px-3">
<div class="cell cell--6">
<div class="content">6 cells</div>
</div>
<div class="cell cell--6">
<div class="content">6 cells</div>
</div>
<div class="cell cell--6">
<div class="content">6 cells</div>
</div>
<div class="cell cell--6">
<div class="content">6 cells</div>
</div>
</div>
</div>
```html
<div class="grid-container">
<div class="grid grid--px-3">
<div class="cell cell--6"><div>6 cells</div></div>
<div class="cell cell--6"><div>6 cells</div></div>
<div class="cell cell--6"><div>6 cells</div></div>
<div class="cell cell--6"><div>6 cells</div></div>
</div>
</div>
```
<div class="grid-container my-5 grid-example">
<div class="grid grid--py-3">
<div class="cell cell--6">
<div class="content">6 cells</div>
</div>
<div class="cell cell--6">
<div class="content">6 cells</div>
</div>
<div class="cell cell--6">
<div class="content">6 cells</div>
</div>
<div class="cell cell--6">
<div class="content">6 cells</div>
</div>
</div>
</div>
```html
<div class="grid-container">
<div class="grid grid--py-3">
<div class="cell cell--6"><div>6 cells</div></div>
<div class="cell cell--6"><div>6 cells</div></div>
<div class="cell cell--6"><div>6 cells</div></div>
<div class="cell cell--6"><div>6 cells</div></div>
</div>
</div>
```
## Overflow
<div class="grid-example my-5">
<div class="grid">
<div class="cell cell--6">
<div class="content">loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong</div>
</div>
<div class="cell cell--6">
<div class="content">loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong</div>
</div>
</div>
</div>
<div class="grid-example my-5">
<div class="grid">
<div class="cell cell--4">
<div class="content">loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong</div>
</div>
<div class="cell cell--auto">
<div class="content content--auto">loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong</div>
</div>
</div>
</div>
<div class="grid-example grid-container my-5">
<div class="grid grid--p-3">
<div class="cell cell--6">
<div class="content">loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong</div>
</div>
<div class="cell cell--6">
<div class="content">loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong</div>
</div>
</div>
</div>

View File

@ -1,19 +0,0 @@
---
title: Icons
permalink: /docs/en/icons
key: docs-icons
---
TeXt uses Font Awesome for icons, you can search available icon code snippet [HERE](https://fontawesome.com/icons?d=gallery&q=donw&m=free).
<i class="fas fa-download"></i>
```html
<i class="fas fa-download"></i>
```
<div class="button button--success button--rounded button--lg"><i class="fas fa-download"></i> Download TeXt Theme</div>
```html
<a class="button button--success button--rounded button--lg" href="#"><i class="fas fa-download"></i> Download TeXt Theme</a>
```

View File

@ -1,52 +0,0 @@
---
title: Image
permalink: /docs/en/image
key: docs-image
---
| Type | Class Names |
| ---- | ---- |
| **base** | image |
| **size** | image\-\-md (default), image\-\-xs, image\-\-sm, image\-\-lg, image\-\-xl |
## Size
### Extreme Small
<img class="image image--xs" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
```html
<img class="image image--xs" src=""/>
```
### Small
<img class="image image--sm" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
```html
<img class="image image--sm" src=""/>
```
### Middle
<img class="image image--md" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
```html
<img class="image image--md" src=""/>
```
### Large
<img class="image image--lg" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
```html
<img class="image image--lg" src=""/>
```
### Extreme Large
<img class="image image--xl" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
```html
<img class="image image--xl" src=""/>
```

View File

@ -1,138 +0,0 @@
---
title: Button
permalink: /docs/en/button
key: docs-button
---
| Type | Class Names |
| ---- | ---- |
| **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 |
## Type
### Primary
<div class="button button--primary button--pill">BUTTON</div>
[BUTTON](#){:.button.button--primary.button--pill}
```html
<a class="button button--primary button--pill" href="">BUTTON</a>
```
### Secondary
<div class="button button--secondary button--pill">BUTTON</div>
[BUTTON](#){:.button.button--secondary.button--pill}
```html
<a class="button button--secondary button--pill" href="">BUTTON</a>
```
### Success
<div class="button button--success button--pill">BUTTON</div>
[BUTTON](#){:.button.button--success.button--pill}
```html
<a class="button button--success button--pill" href="">BUTTON</a>
```
### Outline
<div class="button button--outline-success button--pill">BUTTON</div>
[BUTTON](#){:.button.button--outline-success.button--pill}
```html
<a class="button button--outline-success button--pill" href="">BUTTON</a>
```
## Shape
### Pill
<div class="button button--primary button--pill">BUTTON</div>
[BUTTON](#){:.button.button--primary.button--pill}
```html
<a class="button button--primary button--pill" href="">BUTTON</a>
```
### Rounded
<div class="button button--primary button--rounded">BUTTON</div>
[BUTTON](#){:.button.button--primary.button--rounded}
```html
<a class="button button--primary button--rounded" href="">BUTTON</a>
```
### Circle
<div class="button button--primary button--circle">X</div>
[X](#){:.button.button--primary.button--circle}
```html
<a class="button button--primary button--circle" href="">X</a>
```
## Size
### Extreme Small
<div class="button button--primary button--rounded button--xs">BUTTON</div>
[BUTTON](#){:.button.button--primary.button--rounded.button--xs}
```html
<a class="button button--primary button--rounded button--xs" href="">BUTTON</a>
```
### Small
<div class="button button--primary button--rounded button--sm">BUTTON</div>
[BUTTON](#){:.button.button--primary.button--rounded.button--sm}
```html
<a class="button button--primary button--rounded button--sm" href="">BUTTON</a>
```
### Middle
<div class="button button--primary button--rounded">BUTTON</div>
[BUTTON](#){:.button.button--primary.button--rounded}
```html
<a class="button button--primary button--rounded" href="">BUTTON</a>
```
### Large
<div class="button button--primary button--rounded button--lg">BUTTON</div>
[BUTTON](#){:.button.button--primary.button--rounded.button--lg}
```html
<a class="button button--primary button--rounded button--lg" href="">BUTTON</a>
```
### Extreme Large
<div class="button button--primary button--rounded button--xl">BUTTON</div>
[BUTTON](#){:.button.button--primary.button--rounded.button--xl}
```html
<a class="button button--primary button--rounded button--xl" href="">BUTTON</a>
```

View File

@ -1,182 +0,0 @@
---
title: Item
permalink: /docs/en/item
key: docs-item
---
## Content
<div class="item">
<div class="item__content">
<div class="item__header">
<h4>Photograph</h4>
</div>
<div class="item__description">
<p>
A photograph is an image created by light falling on a photosensitive surface, usually photographic film or an electronic image sensor, such as a CCD or a CMOS chip.
</p>
</div>
</div>
</div>
```html
<div class="item">
<div class="item__content">
<div class="item__header">
<h4>Photograph</h4>
</div>
<div class="item__description">
<p>...</p>
</div>
</div>
</div>
```
## Image and Content
<div class="item">
<div class="item__image">
<img class="image" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
</div>
<div class="item__content">
<div class="item__header">
<h4>Photograph</h4>
</div>
</div>
</div>
```html
<div class="item">
<div class="item__image">
<img class="image" src=""/>
</div>
<div class="item__content">
<div class="item__header">
<h4>Photograph</h4>
</div>
</div>
</div>
```
<div class="item">
<div class="item__image">
<img class="image" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
</div>
<div class="item__content">
<div class="item__header">
<h4>Photograph</h4>
</div>
<div class="item__description">
<p>
A photograph is an image created by light falling on a photosensitive surface, usually photographic film or an electronic image sensor, such as a CCD or a CMOS chip.
</p>
</div>
</div>
</div>
```html
<div class="item">
<div class="item__image">
<img class="image" src=""/>
</div>
<div class="item__content">
<div class="item__header">
<h4>Photograph</h4>
</div>
<div class="item__description">
<p>...</p>
</div>
</div>
</div>
```
## Image Size
<div class="item">
<div class="item__image">
<img class="image image--xs" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
</div>
<div class="item__content">
<div class="item__header">
<h4>Photograph</h4>
</div>
</div>
</div>
```html
<div class="item">
<div class="item__image">
<img class="image image--xs" src=""/>
</div>
<div class="item__content">
<div class="item__header">
<h4>Photograph</h4>
</div>
</div>
</div>
```
<div class="item">
<div class="item__image">
<img class="image image--sm" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
</div>
<div class="item__content">
<div class="item__header">
<h4>Photograph</h4>
</div>
<div class="item__description">
<p>
A photograph is an image created by light falling on a photosensitive surface, usually photographic film or an electronic image sensor, such as a CCD or a CMOS chip.
</p>
</div>
</div>
</div>
```html
<div class="item">
<div class="item__image">
<img class="image image--sm" src=""/>
</div>
<div class="item__content">
<div class="item__header">
<h4>Photograph</h4>
</div>
<div class="item__description">
<p>...</p>
</div>
</div>
</div>
```
<div class="item">
<div class="item__image">
<img class="image image--lg" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
</div>
<div class="item__content">
<div class="item__header">
<h4>Photograph</h4>
</div>
<div class="item__description">
<p>
A photograph is an image created by light falling on a photosensitive surface, usually photographic film or an electronic image sensor, such as a CCD or a CMOS chip.
</p>
</div>
</div>
</div>
```html
<div class="item">
<div class="item__image">
<img class="image image--lg" src=""/>
</div>
<div class="item__content">
<div class="item__header">
<h4>Photograph</h4>
</div>
<div class="item__description">
<p>...</p>
</div>
</div>
</div>
```

View File

@ -1,185 +0,0 @@
---
title: Card
permalink: /docs/en/card
key: docs-card
---
## Image
<div class="card">
<div class="card__image">
<img class="image" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
</div>
</div>
```html
<div class="card">
<div class="card__image">
<img class="image" src=""/>
</div>
</div>
```
## Content
<div class="card">
<div class="card__content">
<div class="card__header">
<h4>Photograph</h4>
</div>
<p>A photograph is an image created by light falling on a photosensitive surface, usually photographic film or an electronic image sensor, such as a CCD or a CMOS chip.</p>
</div>
</div>
```html
<div class="card">
<div class="card__content">
<div class="card__header">
<h4>Photograph</h4>
</div>
<p>...</p>
</div>
</div>
```
## Image and Content
<div class="card">
<div class="card__image">
<img class="image" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
</div>
<div class="card__content">
<div class="card__header">
<h4>Photograph</h4>
</div>
</div>
</div>
```html
<div class="card">
<div class="card__image">
<img class="image" src=""/>
</div>
<div class="card__content">
<div class="card__header">
<h4>Photograph</h4>
</div>
</div>
</div>
```
<div class="card">
<div class="card__image">
<img class="image" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
</div>
<div class="card__content">
<div class="card__header">
<h4>Photograph</h4>
</div>
<p>
A photograph is an image created by light falling on a photosensitive surface, usually photographic film or an electronic image sensor, such as a CCD or a CMOS chip.
</p>
</div>
</div>
```html
<div class="card">
<div class="card__image">
<img class="image" src=""/>
</div>
<div class="card__content">
<div class="card__header">
<h4>Photograph</h4>
</div>
<p>...</p>
</div>
</div>
```
## Image Overlay
<div class="card">
<div class="card__image">
<img class="image" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
<div class="overlay">
<p>Photograph</p>
</div>
</div>
</div>
```html
<div class="card">
<div class="card__image">
<img class="image" src=""/>
<div class="overlay">
<p>Photograph</p>
</div>
</div>
</div>
```
<div class="card">
<div class="card__image">
<img class="image" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
<div class="overlay overlay--bottom">
<p>Photograph</p>
</div>
</div>
</div>
```html
<div class="card">
<div class="card__image">
<img class="image" src=""/>
<div class="overlay overlay--bottom">
<p>Photograph</p>
</div>
</div>
</div>
```
## Flat
<div class="card card--flat">
<div class="card__image">
<img class="image" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
</div>
<div class="card__content">
<div class="card__header">
<h4>Photograph</h4>
</div>
</div>
</div>
```html
<div class="card card--flat">
<div class="card__image">
<img class="image" src=""/>
</div>
<div class="card__content">
<div class="card__header">
<h4>Photograph</h4>
</div>
</div>
</div>
```
## Clickable
<div>
<div class="card card--clickable">
<div class="card__image">
<img class="image" src="https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/image.jpg"/>
</div>
</div>
</div>
```html
<a href="">
<div class="card card--clickable">
<div class="card__image">
<img class="image" src=""/>
</div>
</div>
</a>
```

View File

@ -1,168 +0,0 @@
---
title: Hero
permalink: /docs/en/hero
key: docs-hero
---
<style>
.hero-example p {
margin: .5rem 0;
}
.hero-example--height {
height: 500px;
}
.hero-fill-example {
background-color: #ccc;
}
.hero-fill-example--dark {
background-color: #123;
}
.hero-bg-image-example {
background-image: url("https://kitian616.github.io/jekyll-TeXt-theme/docs/assets/images/cover3.jpg");
}
.hero-bg-image-example--linear-gradient {
background-image: linear-gradient(135deg, rgba(255, 69, 0, .5), rgba(255, 197, 0, .2)), url("https://kitian616.github.io/jekyll-TeXt-theme/docs/assets/images/cover3.jpg");
}
</style>
## Normal
<div class="hero hero-example hero-fill-example my-3">
<div class="hero__content">
<h3>Hero</h3>
</div>
</div>
```html
<div class="hero" style="background-color: #ccc;">
<div class="hero__content">
<h3>Hero</h3>
</div>
</div>
```
## Center
<div class="hero hero-example hero--center hero-fill-example my-3">
<div class="hero__content">
<h3>Hero</h3>
</div>
</div>
```html
<div class="hero hero--center" style="background-color: #ccc;">
<div class="hero__content">
<h3>Hero</h3>
</div>
</div>
```
## Dark Theme
<div class="hero hero-example hero--dark hero-fill-example--dark my-3">
<div class="hero__content">
<h3>Hero</h3>
</div>
</div>
```html
<div class="hero hero--dark" style="background-color: #123;">
<div class="hero__content">
<h3>Hero</h3>
</div>
</div>
```
## Background Image
<div class="hero hero-example hero--dark hero-bg-image-example my-3">
<div class="hero__content">
<h3>Hero</h3>
</div>
</div>
```html
<div class="hero hero--dark" style='background-image: url("path-to-image");'>
<div class="hero__content">
<h3>Hero</h3>
</div>
</div>
```
<div class="hero hero-example hero--dark hero-bg-image-example my-3">
<div class="hero__content">
<h3>Hero</h3>
<p>There's a hero, If you look inside your heart,</p>
<p>You don't have to be afraid of what you are.</p>
</div>
</div>
```html
<div class="hero hero--dark" style='background-image: url("path-to-image");'>
<div class="hero__content">
<h3>Hero</h3>
<p>...</p>
</div>
</div>
```
## Height
<div class="hero hero-example hero--dark hero-bg-image-example hero-example--height my-3">
<div class="hero__content">
<h3>Hero</h3>
<p>There's a hero, If you look inside your heart,</p>
<p>You don't have to be afraid of what you are.</p>
</div>
</div>
```html
<div class="hero hero--dark" style='height: 500px; background-image: url("path-to-image");'>
<div class="hero__content">
<h3>Hero</h3>
<p>...</p>
</div>
</div>
```
## Background Image + Center
<div class="hero hero-example hero--center hero--dark hero-bg-image-example my-3">
<div class="hero__content">
<h3>Hero</h3>
<p>There's a hero, If you look inside your heart,</p>
<p>You don't have to be afraid of what you are.</p>
</div>
</div>
```html
<div class="hero hero--center hero--dark" style='background-image: url("path-to-image");'>
<div class="hero__content">
<h3>Hero</h3>
<p>...</p>
</div>
</div>
```
<div class="hero hero-example hero--center hero--dark hero-bg-image-example--linear-gradient my-3">
<div class="hero__content">
<h3>Hero</h3>
<p>There's a hero, If you look inside your heart,</p>
<p>You don't have to be afraid of what you are.</p>
</div>
</div>
```html
<style>
.hero-example--linear-gradient {
background-image: linear-gradient(135deg, rgba(255, 69, 0, .5), rgba(255, 197, 0, .2)), url("path-to-image");
}
</style>
<div class="hero hero--center hero--dark hero-example--linear-gradient">
<div class="hero__content">
<h3>Hero</h3>
<p>...</p>
</div>
</div>
```

View File

@ -1,161 +0,0 @@
---
title: Swiper
permalink: /docs/en/swiper
key: docs-swiper
---
<style>
.swiper-demo {
height: 220px;
}
.swiper-demo .swiper__slide {
display: flex;
align-items: center;
justify-content: center;
font-size: 3rem;
color: #fff;
}
.swiper-demo .swiper__slide:nth-child(even) {
background-color: #ff69b4;
}
.swiper-demo .swiper__slide:nth-child(odd) {
background-color: #2593fc;
}
.swiper-demo--dark .swiper__slide:nth-child(even) {
background-color: #312;
}
.swiper-demo--dark .swiper__slide:nth-child(odd) {
background-color: #123;
}
.swiper-demo--image .swiper__slide:nth-child(n) {
background-color: #000;
}
</style>
`Alpha`{:.warning}
## Normal
<div class="swiper my-3 swiper-demo swiper-demo--0">
<div class="swiper__wrapper">
<div class="swiper__slide">1</div>
<div class="swiper__slide">2</div>
<div class="swiper__slide">3</div>
<div class="swiper__slide">4</div>
<div class="swiper__slide">5</div>
<div class="swiper__slide">6</div>
<div class="swiper__slide">7</div>
</div>
<!-- <div class="swiper__pagination"></div> -->
<div class="swiper__button swiper__button--prev fas fa-chevron-left"></div>
<div class="swiper__button swiper__button--next fas fa-chevron-right"></div>
<!-- <div class="swiper-scrollbar"></div> -->
</div>
```css
.swiper-demo {
height: 220px;
}
```
```html
<div class="swiper swiper-demo">
<div class="swiper__wrapper">
<div class="swiper__slide">1</div>
<div class="swiper__slide">2</div>
<div class="swiper__slide">3</div>
<div class="swiper__slide">4</div>
<div class="swiper__slide">5</div>
<div class="swiper__slide">6</div>
<div class="swiper__slide">7</div>
</div>
<div class="swiper__button swiper__button--prev fas fa-chevron-left"></div>
<div class="swiper__button swiper__button--next fas fa-chevron-right"></div>
</div>
```
```js
{%- raw -%}
{%- include scripts/lib/swiper.js -%}
var SOURCES = window.TEXT_VARIABLES.sources;
window.Lazyload.js(SOURCES.jquery, function() {
$('.swiper-demo').swiper();
});
{% endraw %}
```
## Light Theme
<div class="swiper swiper--light my-3 swiper-demo swiper-demo--1">
<div class="swiper__wrapper">
<div class="swiper__slide">1</div>
<div class="swiper__slide">2</div>
<div class="swiper__slide">3</div>
<div class="swiper__slide">4</div>
<div class="swiper__slide">5</div>
<div class="swiper__slide">6</div>
<div class="swiper__slide">7</div>
</div>
<div class="swiper__button swiper__button--prev fas fa-chevron-left"></div>
<div class="swiper__button swiper__button--next fas fa-chevron-right"></div>
</div>
## Dark Theme
<div class="swiper swiper--dark my-3 swiper-demo swiper-demo--dark swiper-demo--2">
<div class="swiper__wrapper">
<div class="swiper__slide">1</div>
<div class="swiper__slide">2</div>
<div class="swiper__slide">3</div>
<div class="swiper__slide">4</div>
<div class="swiper__slide">5</div>
<div class="swiper__slide">6</div>
<div class="swiper__slide">7</div>
</div>
<div class="swiper__button swiper__button--prev fas fa-chevron-left"></div>
<div class="swiper__button swiper__button--next fas fa-chevron-right"></div>
</div>
## Images
<div class="swiper my-3 swiper-demo swiper-demo--image swiper-demo--3">
<div class="swiper__wrapper">
<div class="swiper__slide"><img class="lightbox-ignore" src="https://kitian616.github.io/jekyll-TeXt-theme/docs/assets/images/cover3.jpg"/></div>
<div class="swiper__slide"><img class="lightbox-ignore" src="https://kitian616.github.io/jekyll-TeXt-theme/docs/assets/images/cover2.jpg"/></div>
<div class="swiper__slide"><img class="lightbox-ignore" src="https://kitian616.github.io/jekyll-TeXt-theme/docs/assets/images/cover3.jpg"/></div>
<div class="swiper__slide"><img class="lightbox-ignore" src="https://kitian616.github.io/jekyll-TeXt-theme/docs/assets/images/cover2.jpg"/></div>
<div class="swiper__slide"><img class="lightbox-ignore" src="https://kitian616.github.io/jekyll-TeXt-theme/docs/assets/images/cover3.jpg"/></div>
<div class="swiper__slide"><img class="lightbox-ignore" src="https://kitian616.github.io/jekyll-TeXt-theme/docs/assets/images/cover2.jpg"/></div>
<div class="swiper__slide"><img class="lightbox-ignore" src="https://kitian616.github.io/jekyll-TeXt-theme/docs/assets/images/cover3.jpg"/></div>
</div>
<div class="swiper__button swiper__button--prev fas fa-chevron-left"></div>
<div class="swiper__button swiper__button--next fas fa-chevron-right"></div>
</div>
## Without Animation
<div class="swiper my-3 swiper-demo swiper-demo--4">
<div class="swiper__wrapper">
<div class="swiper__slide">1</div>
<div class="swiper__slide">2</div>
<div class="swiper__slide">3</div>
<div class="swiper__slide">4</div>
<div class="swiper__slide">5</div>
<div class="swiper__slide">6</div>
<div class="swiper__slide">7</div>
</div>
<div class="swiper__button swiper__button--prev fas fa-chevron-left"></div>
<div class="swiper__button swiper__button--next fas fa-chevron-right"></div>
</div>
<script>
{%- include scripts/lib/swiper.js -%}
var SOURCES = window.TEXT_VARIABLES.sources;
window.Lazyload.js(SOURCES.jquery, function() {
$('.swiper-demo--0').swiper();
$('.swiper-demo--1').swiper();
$('.swiper-demo--2').swiper();
$('.swiper-demo--3').swiper();
$('.swiper-demo--4').swiper({ animation: false });
});
</script>

View File

@ -1,145 +0,0 @@
---
title: 快速开始
permalink: /docs/zh/quick-start
key: docs-quick-start-zh
---
TeXt 是一款 100% 兼容 GitHub Pages 的 Jekyll 主题,你可以通过 Fork、下载或主题等方式安装。
在这篇文章中,你将学到如何**安装设置主题**,通过**本地预览**进行开发以及**编译**和**发布**。
<!--more-->
```mermaid
graph LR;
A0(安装 TeXt)
B0(普通方式)
B1[主题方式]
C0[从 GitHub 克隆]
C1[Fork 该仓库]
C2[下载]
D0[设置]
E0(安装开发环境)
F0[直接安装]
F1[使用 Docker]
A0-->B0;
A0-->B1;
B0-->C0;
B0-->C1;
B0-->C2;
B1-->D0;
C1-->E0
C2-->E0
D0-->E0
E0-->F0
E0-->F1
```
## 安装
### 普通方式
这种方式要求你的项目里包含所有的主题文件,你可以通过以下途径来安装:
1. 从 GitHub 克隆 [jekyll-TeXt-theme](https://github.com/kitian616/jekyll-TeXt-theme) 项目:
**通过 HTTPS 方式克隆:**
```bash
git clone https://github.com/kitian616/jekyll-TeXt-theme.git
```
**通过 SSH 方式克隆:**
```bash
git clone git@github.com:kitian616/jekyll-TeXt-theme.git
```
2. 下载主题压缩包并解压到你的项目目录中:
<a class="button button--success button--rounded" href="https://github.com/kitian616/jekyll-TeXt-theme/archive/master.zip"><i class="fas fa-download"></i> 下载 TeXt 主题</a>
3. 如果你打算在 GitHub Pages 上搭建你的网站,你可以直接 fork [jekyll-TeXt-theme](https://github.com/kitian616/jekyll-TeXt-theme) 到你的仓库,然后将其重命名为 **USERNAME.github.io** — 这里的 **USERNAME** 是你的 GitHub 用户名。
![Fork](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/github-fork.jpg)
![Rename](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/github-rename-repo.jpg)
### 主题方式
1. 若要安装一套主题,请先将该主题添加到您站点的 *Gemfile* 文件中:
```ruby
gem "jekyll-text-theme"
```
2. 向站点的 *_config.yml* 中加入下列代码来启用主题:
```yaml
theme: jekyll-text-theme
```
## 设置
**这里仅针对主题方式的安装,普通方式安装请跳过。**
Jekyll 主题含有主题默认的布局文件、包含文件和样式表, 但是有些目录(例如*assets*, *_layouts*, *_includes* 以及 *_sass* 目录)需要手动添加到项目目录中,这样的好处在于将主题的文件和站点的内容和配置隔离开来,方便主题的升级。
```bash
├── 404.html
├── Gemfile
├── _config.yml
├── _data
│   └── locale.yml
├── _posts
│   └── ...
├── about.md
├── archive.html
└── index.html
```
你可以参考主题源码的 [/test 目录](https://github.com/kitian616/jekyll-TeXt-theme/tree/master/test), 这是一个使用主题的示例。
## 安装开发环境
如果你想本地运行主题,你需要安装 Ruby 以及 Jekyll详情请戳 [这里](https://jekyllrb.com/docs/installation/)。
上述步骤完成后,安装 Ruby 依赖包:
```bash
bundle install --path vendor/bundle
```
当然TeXt 还提供了 [Docker](https://www.docker.com/) 支持,使用 Docker 能让你更方便的完成环境的安装,并且环境统一,不会出错。
![Docker](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/docker.jpg){:width="400px"}
你只需要以下 3 步即可通过 Docker 完成环境的搭建:
1. [安装 Docker](https://docs.docker.com/install/)。
2. 生成 *Gemfile.lock* 文件:
```bash
docker run --rm -v "$PWD":/usr/src/app -w /usr/src/app ruby:2.6 bundle install
```
3. 创建 Docker 镜像 (Image)
```bash
docker-compose -f ./docker/docker-compose.build-image.yml build
```
## 本地预览
Jekyll 集成了一个开发用的服务器,可以让你使用浏览器在本地进行预览。
通过 `bundle exec jekyll serve` 命令启动开发服务器,然后你就可以访问 [http://localhost:4000/](http://localhost:4000/) 预览你的网站了。
如果是通过 Docker 搭建的环境,请运行 `docker-compose -f ./docker/docker-compose.default.yml up` 命令以启动开发服务器。
## 编译和发布
如果你打算把网站搭建在 GitHub Pages 上,那你所需要做的就是将项目的源码上传到 USERNAME.github.io 源码仓库的 master 分支GitHub 会自动的编译,几分钟后你就可以通过 **https://USERNAME.github.io** 访问到你的网站了。
如果你的网站是搭建在其他服务器上的,那么你就需要来自己编译了。首先运行命令 `JEKYLL_ENV=production bundle exec jekyll build` 编译你的网站,然后将编译的文件(位于 *_site* 目录)更新到你的服务器上。

View File

@ -1,215 +0,0 @@
---
title: 从 1.x 升级到 2.x
permalink: /docs/zh/update-from-1-to-2
key: docs-update-from-1-to-2-zh
---
![TeXt 2](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/TeXt-version-2.jpg)
经过几个月的努力,**TeXt 2** 终于发布了,第二版在第一版的基础上做了大量的重构与更改,这也导致了一些配置的不兼容。希望这篇文档能对你的升级起到一些帮助,感谢你们的支持。
## 皮肤
*_config.yml* 中 `text_color_theme` 配置项更名为 `text_skin`
1.x:
```yml
text_color_theme: forest
```
```yml
text_skin: forest
```
## Layout
### Article 布局
“Post 布局”和“Page 布局”更名为“Article 布局”。
1.x
```yml
layout: post
```
```yml
layout: page
```
2.x
```yml
layout: article
```
由于新的“Article 布局”默认不显示 Toc、在 GitHub 上编辑按钮、许可协议和阅读量。为了和之前的“Post 布局”保持一致,可以在头信息里设置:
```yml
license: true
aside:
toc: true
show_edit_on_github: true
pageview: true
```
你也可以在 *_config.yml* 中设置 posts 类型的[默认值](https://jekyllrb.com/docs/configuration/#front-matter-defaults)
```yml
defaults:
- scope:
path: ""
type: posts
values:
layout: article
license: true
aside:
toc: true
show_edit_on_github: true
pageview: true
```
### Archive 布局
原有的“All 布局”更名为“Archive 布局”。
1.x
```yml
layout: all
```
2.x
```yml
layout: archive
```
## Paths
为了保持和布局命名的一致性,新版将原有的 *all.html* 更名为 *archive.html*。*_config.yml* 中 `paths` 的配置项 `base``all` 分别更名为 `root``archive`
1.x:
```yml
paths:
base : /blog
all : /blog/all.html
rss : /feed.xml
```
2.x:
```yml
paths:
root : /blog
home : /blog
archive : /blog/archive.html
rss : /feed.xml
```
## 许可协议
对于许可协议,你还需要在 *_config.yml* 中指定使用的许可协议, 默认为 `false` 不显示:
```yml
license: CC-BY-4.0
```
## 评论
新版对评论、文章点击量和站点统计在 *_config.yml* 中的配置做了一些变化,主要是增加了 `provider` 属性,并且将对应的提供方变为对应的子配置项。
1.x
```yml
disqus:
shortname: kitian616-github-io
```
2.x
```yml
comments:
provider: disqus
disqus:
shortname: kitian616-github-io
```
## 文章点击量
1.x
```yml
leancloud:
app_id: uAG3OhdcH8H4fxSqXLyBljA7-gzGzoHsz
app_key: Mzf5m9skSwYVWVXhGiYMNyXs
app_class: ThomasBlog
```
2.x
```yml
pageview:
provider: leancloud
leancloud:
app_id: uAG3OhdcH8H4fxSqXLyBljA7-gzGzoHsz
app_key: Mzf5m9skSwYVWVXhGiYMNyXs
app_class: ThomasBlog
```
## 站点统计
1.x
```yml
ga_tracking_id: UA-71907556-1
```
2.x
```yml
analytics:
provider: google
google:
tracking_id: UA-71907556-1
```
## Logo 和 Favicon
默认 Logo 的位置发生了变化。移除了之前的图标生成工具,新版推荐使用 [RealFaviconGenerator](https://realfavicongenerator.net/) 来生成 Favicon。
## 导航
网站右上的导航配置移到了 *_data/navigation.yml* 中,在新版中整个导航都可以自由定制了。
1.x
```yml
nav_lists:
- titles:
en: About
zh: 关于
zh-Hans: 关于
zh-Hant: 關於
url: /blog/about.html
```
2.x
```yml
## _data/navigation.yml
header:
- titles:
en: Archive
zh: 归档
zh-Hans: 归档
zh-Hant: 歸檔
url: /blog/archive.html
- titles:
en: About
zh: 关于
zh-Hans: 关于
zh-Hant: 關於
url: /blog/about.html
```

View File

@ -1,382 +0,0 @@
---
title: 配置
permalink: /docs/zh/configuration
key: docs-configuration-zh
---
Jekyll 允许你很轻松的设计你的网站,这很大程度上归功于灵活强大的配置功能。既可以配置在网站根目录下的 *_config.yml* 文件,也可以作为命令行的标记来配置。
*_config.yml* 包括一些在运行时一次性读入的全局配置和变量定义, 在自动生成的过程中并**不会**重新加载,除非重新运行。注意 Data Files 包括在自动生成范围内,可以在更改后自动重新加载。
{:.warning}
<!--more-->
## 网站配置项
### 主题
如果是通过主题方式安装的,你需要这样配置以启用主题:
```yaml
theme: jekyll-text-theme
```
### 皮肤
TeXt 内置有 6 套皮肤,你也可以定制自己的皮肤。
| `default` | `dark` | `forest` |
| --- | --- | --- |
| ![Default](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_default.jpg) | ![Dark](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_dark.jpg) | ![Forest](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_forest.jpg) |
| `ocean` | `chocolate` | `orange` |
| --- | --- | --- |
| ![Ocean](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_ocean.jpg) | ![Chocolate](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_chocolate.jpg) | ![Orange](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/screenshots/skins_orange.jpg) |
```yaml
text_skin: default # "default" (default), "dark", "forest", "ocean", "chocolate", "orange"
```
### 代码高亮主题
TeXt 使用 [Tomorrow](https://github.com/chriskempson/tomorrow-theme) 作为它的代码高亮主题。
| `tomorrow` | `tomorrow-night` | `tomorrow-night-eighties` | `tomorrow-night-blue` | `tomorrow-night-bright` |
| --- | --- | --- | --- | --- |
| ![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) |
每个皮肤有一个默认的代码高亮主题,当然你可以通过 `highlight_theme` 配置项来指定其他主题。
```yaml
highlight_theme: default # "default" (default), "tomorrow", "tomorrow-night", "tomorrow-night-eighties", "tomorrow-night-blue", "tomorrow-night-bright"
```
### URL
网站的协议和域名。
如果你的网站是搭建在 Github Pages 上的,这个只会被设置为 GitHub Pages 域名CNAME 或个人域名)[^gitHub_metadata]. 举个例子, https://kitian616.github.io 或者 https://kitian616.github.io 如果设置了 CNAME。
在 3.3 及更高版本的 Jekyll 中运行 `jekyll serve` 命令会在开发模式时将其设置为 url: http://localhost:4000你可以通过 `JEKYLL_ENV=production` 设置生产环境。
{:.warning}
[^gitHub_metadata]: [GitHub Metadata, a.k.a. site.github](https://github.com/jekyll/github-metadata#what-it-does)
[^jekyll_site_variables]: [Variables#Site Variables](https://jekyllrb.com/docs/variables/#site-variables)
[^jekyll_specifying_environment]: [Configuration#Specifying a Jekyll environment at build timePermalink](https://jekyllrb.com/docs/configuration/#specifying-a-jekyll-environment-at-build-time)
### Base URL
网站的根路径,不包含域名,其默认值为“/”。如果你的网站是搭建在 Github Pages 上的,那么这个值会默认设置为网站对应的项目名[^gitHub_metadata]。
### 网站标题
网站的标题。
```yaml
title: "My Awesome Website"
```
### 网站描述
使用一些简短的语言来描述你的网站。
```yaml
description: > # this means to ignore newlines until "nav_lists:"
A website with awesome stories.
```
## 语言与时区
### 语言
网站的语言,当然你可以在头信息[^font_matter]里指定特定的文章或页面的语言,你可以在[国际化](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/i18n)找到更多信息。
```yaml
lang: en
```
[^font_matter]: [Front Matter](https://jekyllrb.com/docs/frontmatter/)
### 时区
设置时区,这个设置作用于 TZ 变量, Ruby 用它来处理日期和时间。使用 IANA Time Zone Database 标准,比如 America/New_York 。其默认值为操作系统的时区。详情请戳 [这里](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)。[^jekyll_global_configuration]
[^jekyll_global_configuration]: [Configuration#Global Configuration](https://jekyllrb.com/docs/configuration/#global-configuration)
```yaml
timezone: Asia/Shanghai
```
## 作者信息
网站作者的信息(可以是个人、团队或者组织)。
### 类型 (type)
作者的类型,个人或者是组织,作为 [schema.org](https://schema.org/) 的语义化标记使用。
### 作者名 (name)
用来表明网站的作者。
### 头像 (avatar)
作者的图片或 Logo。
### 简介 (bio)
关于作者的一个简单介绍。
### 社交
社交网站的用户名或用户 ID。
目前支持邮件微博FacebookTwitter微博Google PlusTelegramMedium知乎豆瓣LinkedinGithub 和 Npm持续添加中。
当你设置了相应项的值后,对应的社交按钮就会出现在页面下方。
## GitHub 源码仓库
[GitHub Metadata](https://github.com/jekyll/github-metadata) 插件的设置, 详情请戳 [这里](https://github.com/jekyll/github-metadata/blob/master/docs/configuration.md#configuration)。
这个设置告诉 jekyll-github-metadata 插件应该从哪个项目中获取元数据,其格式为 `项目所有者 ID/项目名称`例如kitian616/jekyll-TeXt-theme。
```yaml
repository: user_name/repo_name
```
## 文章配置项
### 摘要
该主题的摘要有两种模式——TEXT 模式和 HTML 模式。 当 *_config.yml* 配置项 `excerpt_type` 的值为 `text` 时是 TEXT 模式,为 `html` 时是 HTML 模式,**默认为 TEXT 模式**。
| 模式名称 | 描述 |
| --- | --- |
| **text** | 此时摘要为纯文本,会过滤掉一切非文本元素(标题,链接,列表,表格,图片等等),且截取前 350 个字符。 |
| **html** | 此时摘要为 HTML 文档,与文章内容一致,并且 **默认展示整篇文章的内容**。若想控制摘要内容,需要在文章中想要显示到的地方加上 `<!--more-->`,详情请戳 [这里](https://jekyllrb.com/docs/posts/#post-excerpts)。 |
```yaml
excerpt_separator: <!--more-->
excerpt_type: text # text (default), html
```
该设置在 2.2.0 版中移到了 Articles 和 Home 布局的头信息中,详情请戳 [这里](https://kitian616.github.io/jekyll-TeXt-theme/docs/cn/layouts#articles-layout)。
{:.error}
### 许可协议
| 名称 | 许可协议 | 图片 |
| --- | --- | --- |
| CC-BY-4.0 | [Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) | ![CC-BY-4.0](https://i.creativecommons.org/l/by/4.0/88x31.png) |
| CC-BY-SA-4.0 | [Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/) | ![CC-BY-SA-4.0](https://i.creativecommons.org/l/by-sa/4.0/88x31.png) |
| CC-BY-NC-4.0 | [Attribution-NonCommercial 4.0 International](https://creativecommons.org/licenses/by-nc/4.0/) | ![CC-BY-NC-4.0](https://i.creativecommons.org/l/by-nc/4.0/88x31.png) |
| CC-BY-ND-4.0 | [Attribution-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nd/4.0/) | ![CC-BY-ND-4.0](https://i.creativecommons.org/l/by-nd/4.0/88x31.png) |
```yaml
license: CC-BY-NC-4.0
```
### 目录
作为文章目录的元素。
```yaml
toc:
selectors: "h1,h2,h3"
```
### Markdown 增强
为了增强文章的写作和阅读体验TeXt 对 Jekyll 现有的 markdown 做了一些增强。当然这些增强都是默认禁止的,你需要设置相应的配置项为 true 来启动它们:
```yaml
# Mathjax
mathjax: true
mathjax_autoNumber: true
# Mermaid
mermaid: true
# Chart
chart: true
```
当然你也可以为某一篇文章或页面通过头信息[^font_matter]来做单独的指定。
在 [撰写博客](/) 篇中有更详细的使用说明。
## 分页
[Jekyll Paginate](https://github.com/jekyll/jekyll-paginate) 插件的配置。
要想对文章列表做分页,你需要在 *_config.yml* 文件中配置每页显示的文章数:
```yaml
paginate: 8
```
这个数字代表了文章列表页每页显示的最大文章数。
你也可以像这样指定分页页面的地址:
```yaml
paginate_path: /page:num # don't change this unless for special need
```
## CDN 源
TeXt 使用 CDN[^cdn] 来加快载入速度,你可以选择 [BootCDN](http://www.bootcdn.cn/)(默认项)或者[unpkg](https://unpkg.com/)作为网站的 CDN 源。它们都是开源而免费的。
国内用户请优先使用 BootCDN。
```yaml
sources: bootcdn # bootcdn (default), unpkg
```
[^cdn]: [Content delivery network](https://en.wikipedia.org/wiki/Content_delivery_network)
## 分享
| 名称 | 分享系统提供方 | 最低版本 |
| --- | --- | --- |
| **addtoany** | [AddToAny](https://www.addtoany.com/) | 2.2.2 |
| **addthis** | [AddThis](https://www.addthis.com/) | 2.2.3 |
| **custom** | | |
### AddToAny
```yaml
comments:
provider: addtoany
```
### AddThis
```yaml
comments:
provider: addthis
addthis:
id: "your-addthis-pubid"
```
你需要在页面的头信息里设置 `sharing` 属性为 `true` 来开启该页的评论,详情请戳 [这里](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/layouts#article-%E5%B8%83%E5%B1%80)。
{:.warning}
## 评论
| 名称 | 评论系统提供方 | 最低版本 |
| --- | --- | --- |
| **disqus** | [Disqus](https://disqus.com/) | |
| **gitalk** | [Gitalk](https://github.com/gitalk/gitalk/) | |
| **valine** | [Valine](https://valine.js.org/en/) | 2.2.4 |
| **custom** | | |
### Disqus
要想启用 Disqus 作为评论系统,你需要注册一个 Disqus 账号然后申请一个针对该网站的 [shortname](https://help.disqus.com/customer/portal/articles/466208-what-s-a-shortname-),完成后将 shortname 填入到 *_config.yml* 中:
```yaml
comments:
provider: disqus
disqus:
shortname: "your-disqus-shortname"
```
### Gitalk
要想启用 Gitalk 作为评论系统,首先你需要一个 GitHub Application如果没有[点击这里](https://github.com/settings/applications/new)申请。然后将相应的参数添加到 *_config.yml* 配置中:
```yaml
comments:
provider: gitalk
gitalk:
clientID : "github-application-client-id"
clientSecret: "github-application-client-secret"
repository : "github-repo"
owner : "github-repo-owner"
admin: # Github repo owner and collaborators, only these guys can initialize github issues, IT IS A LIST.
- "your-github-id"
- "the-other-admin-github-id"
```
### Valine
要想启用 Valine 作为评论系统,你需要注册一个 LeanCloud 账号然后建立一个 LeanCloud 应用,详情见 [LeanCloud](#leancloud)。因为 Valine 会自动在应用中建立一个 Class因此并不需要像文章点击量那样手动建立 Class。
可以和[文章点击量](#文章点击量)公用一个 LeanCloud 应用。
```yaml
comments:
provider: valine
valine:
app_id : "your-leanCloud-app-id"
app_key : "your-leanCloud-app-key"
```
对于上面所有的评论系统, 你都需要在页面的头信息里设置 `key` 属性来开启该页的评论,详情请戳 [这里](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/layouts#page-%E5%B8%83%E5%B1%80)。
{:.warning}
## 文章点击量
| 名称 | 文章点击量后台提供方 |
| --- | --- |
| **leancloud** | [LeanCloud](https://leancloud.cn/) |
| **custom** | |
### LeanCloud
TeXt 使用 LeanCloud 作为点击量功能的后台服务。你需要建立一个 LeanCloud 应用,然后在应用中建立一个 Class之后将必要的信息填写到 *_config.yml* 文件中。下面详细介绍其操作步骤。
在进入[主页](https://leancloud.cn/)后点击页面右上角的“访问控制台”,然后注册账号并登录。
在应用面板存储子页中点击“创建应用”按钮,在弹出的对话框中填写应用名称,计价方案选择“开发版”(土豪随意),然后点击“创建”按钮创建应用。
创建完成后应用面板上会出现你刚刚创建的应用卡片,点击进入选择创建 Class
![Leancloud创建 Class 0](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/leancloud-create-class-0.jpg){:style="max-height:420px"}{:.border}
在弹出的对话框中填写 Class 的名字,权限选择“无限制”,点击“创建 Class”按钮
![Leancloud创建 Class 1](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/leancloud-create-class-1.jpg){:style="max-height:620px"}{:.border}
当然你可以随时更改 Class 的权限,在应用面板存储子页中选择想要修改的 Class点击上面菜单的其他 -> 权限设置项,即可进入设置页:
![Leancloud权限设置](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/leancloud-authorization.jpg){:style="max-height:300px"}
最后点击应用面板右侧的“设置”,点击“应用 Key” 选项,即可得到对应的 APP ID 和 APP KEY
![LeancloudApp Info](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/leancloud-app-info.jpg){:.border}
```yaml
pageview:
provider: leancloud
leancloud:
app_id : "your-leanCloud-app-id"
app_key : "your-leanCloud-app-key"
app_class : "your-leanCloud-app-class"
```
对于上面所有的点击量统计, 你都需要在页面的头信息里设置 `key` 属性来开启该页的统计功能,详情请戳 [这里](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/layouts#page-%E5%B8%83%E5%B1%80)。
{:.warning}
## 站点统计
| 名称 | 站点统计提供方 |
| --- | --- |
| **google** | [Google Analytics](https://analytics.google.com/) |
| **custom** | |
### Google Analytics
你需要将 `tracking_id` 设置成你的 Google Analytics 账户中针对该网站的跟踪代码来启动这项功能。你也可以通过设置 `anonymize_ip``true` 将所有事件的 IP 地址匿名化。
```yaml
analytics:
provider: google
google:
tracking_id: "your-google-analytics-tracking-code"
anonymize_ip: true
```

View File

@ -1,66 +0,0 @@
---
title: 导航栏
permalink: /docs/zh/navigation
key: docs-navigation-zh
---
在 TeXt 中有两种导航栏:**头部导航栏**Header Navigation和**侧边栏导航栏**Sidebar Navigation它们均在 *data/navigation.yml* 中配置。
<!--more-->
## 头部导航栏
头部导航栏在 *data/navigation.yml* 文件的 `header` 项定义,它是一个包含标题和 URL 项的数组:
```yaml
header:
- title: Docs
url: /docs/en/quick-start
- title: 文档
url: /docs/zh/quick-start
- titles:
en: Archive
zh: 归档
zh-Hans: 归档
zh-Hant: 歸檔
url: /archive.html
- titles:
en: About
zh: 关于
zh-Hans: 关于
zh-Hant: 關於
url: /about.html
- title: GitHub
url: https://github.com/kitian616/jekyll-TeXt-theme
```
你可以用 `titles` 来定义一个支持多语言的标题名。
## 侧边栏导航栏
要想在某篇文章或页面中使用侧边栏导航栏,首先你需要在 *data/navigation.yml* 中定义一个导航栏。
```yaml
docs-en:
- title: Start
children:
- title: Quick Start
url: /docs/en/quick-start
- title: Structure
url: /docs/en/structure
...
- title: Customization
children:
- title: Configuration
url: /docs/en/configuration
- title: Navigation
url: /docs/en/navigation
...
```
然后在头信息中将定义的导航作为这篇文章或页面的侧边栏导航栏:
```yaml
sidebar:
nav: docs-en
```

View File

@ -1,176 +0,0 @@
---
title: 布局
permalink: /docs/zh/layouts
key: docs-layouts-zh
---
```mermaid
graph TB;
NONE[none]
BASE[base]
PAGE[page]
ARTICLE[article]
ARTICLES[articles]
HOME[home]
ARCHIVE[archive]
LANDING[landing]
404[404]
NONE-->BASE;
BASE-->PAGE;
PAGE-->ARTICLE;
PAGE-->ARTICLES;
ARTICLES-->HOME;
PAGE-->ARCHIVE;
PAGE-->LANDING;
PAGE-->404;
```
## Base 布局
继承于 None。
## Page 布局
继承于 Base 布局。
| 配置项 | 可选值 | 描述 | 最低版本 |
| --- | --- | --- | --- |
| **mode** | normal (default), immersive | 该页的模式。 | 2.2.0 |
| **type** | webpage (default), article | 该页的类型, 作为 [schema.org](https://schema.org/) 的语义化标记使用。 | |
| **key** | `!!str` | 页面的唯一标识符,供评论系统和点击量统计使用。必须以字母(`[A-Za-z]`)开头,其后可以接若干字母、数字(`[0-9]`)、连字符(`-`)、下划线(`_`)、冒号(`:`)和小数点(`.`)。 | |
| **lang** | en (default), zh, zh-Hans, zh-Hant | 该页的语言。 | |
| **author** | `!!map` | 将在 *authors.yml* 中定义的作者作为某篇文章或页面的作者, 详情请看[作者](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/authors)。 | 2.2.0 |
| **show_title** | true (default), false | 是否显示标题,默认显示,设置为 `false` 隐藏。 | |
| **show_edit_on_github** | true, false (default) | 是否显示“在 Github 上修改”按钮,设置为 `true` 显示。你需要先在 *_config.yml* 中设置 `repository``repository_tree`。 | |
| **show_date** | true (default), false | 是否展示该页的发布日期,设置为 `false` 隐藏。 | 2.2.0 |
| **show_tags** | true (default), false | 是否展示该页的标签,设置为 `false` 隐藏。 | 2.2.0 |
| **full_width** | true, false (default) | 该页内容是否占据全部宽度,设置为 `true` 开启。 | |
| **pageview** | true, false (default) | 是否开启阅读量统计,默认关闭,设置为 `true` 开启。 | 2.2.0 |
| **comment** | true (default), false | 是否开启评论支持,默认开启,设置为 `false` 关闭。 | |
| **mathjax** | true, false | 是否开启 Mathjax 公式支持,设置为 `true` 开启。 | |
| **mathjax_autoNumber** | true, false | 该页的 Mathjax 公式是否自动编号,设置为 `true` 开启。 | |
| **mermaid** | true, false | 是否开启 Mermaid 流程图支持,设置为 `true` 开启。 | |
| **chart** | true, false | 是否开启 Chart 图表支持,设置为 `true` 开启。 | |
| **cover** | `!!str` | 封面图片的 URL。 | |
| **header** | false, `!!map` | 设置为 `false` 隐藏标题栏。 | 2.2.0 |
| **article_header**| `!!map` | | 2.2.0 |
| **aside** | `!!map` | | |
| **sidebar** | `!!map` | | |
| **footer** | false | 设置为 `false` 隐藏底部栏。 | 2.2.3 |
| **lightbox** | true, false | 该页的大图是否能点击预览,设置为 `true` 开启,你可以通过设置 `lightbox-ignore` 类名来忽略特定的图片元素。 | 2.2.4 |
### header
| 配置项 | 可选值 | 描述 |
| --- | --- | --- |
| **theme** | light, dark | 当 type 为 `translucent` 时有效。 |
| **background** | `!!str` | 当指定了 theme 值时有效。 |
### article_header
| 配置项 | 可选值 | 描述 |
| --- | --- | --- |
| **type** | overlay, cover | |
| **align** | left (default), center | |
| **theme** | light (default), dark | |
| **background_color** | `!!str` | 当 type 为 `overlay` 时有效。当设置的背景色较深时,你需要设置 `theme` 为 dark。 |
| **background_image** | `!!map` | 当 type 为 `overlay` 时有效,设置为 `false` 可覆盖 `cover` 禁止背景图片。 |
| **image** | `!!map` | 当 type 为 `cover` 时有效。 |
| **actions** | `!!seq` | |
### article_header.background_image
| Variable | Option Values | Description |
| --- | --- | --- |
| **gradient** | `!!str` | |
| **src** | `!!str` | 默认为 `cover` |
### article_header.image
| Variable | Option Values | Description |
| --- | --- | --- |
| **src** | `!!str` | |
### aside
| 配置项 | 可选值 | 描述 |
| --- | --- | --- |
| **toc** | false (default), true | 设置为 `true` 时展示右侧边栏目录。 |
### sidebar
| 配置项 | 可选值 | 描述 |
| --- | --- | --- |
| **nav** | `!!str` | |
## Article 布局
继承于 Page 布局。
| 配置项 | 可选值 | 描述 | 最低版本 |
| --- | --- | --- | --- |
| **modify_date** | `!!str` | 该文章的最后修改时间, 其格式为 `YYYY-MM-DD HH:MM:SS +/-TTTT``date` 的格式相同 | |
| **sharing** | true, false (default) | 是否开启分享,设置为 `true` 开启。 | 2.2.2 |
| **show_author_profile** | true, false (default) | 是否在文章开头显示作者信息卡片,设置为 `true` 显示。 | |
| **show_subscribe**| true, false (default) | 是否在文章末尾显示订阅信息,设置为 `true` 显示。 | latest |
| **license** | true, false (default), CC-BY-4.0, CC-BY-SA-4.0, CC-BY-NC-4.0, CC-BY-ND-4.0 | 该文章的许可协议。设置为 `true` 使用在 *_config.yml* 中设置的 `license` 值,设置为 `false` 不使用许可协议。 | |
## Articles 布局
继承于 Page 布局,从 **2.2.0** 版本支持。
| 配置项 | 可选值 | 描述 |
| --- | --- | --- |
| **articles** | `!!map` | |
### articles
| 配置项 | 可选值 | 描述 |
| --- | --- | --- |
| **data_source** | `!!str` | 如果你将将集合名设置为该项的值,该页面将会展示这个集合下的文章列表。你可以在 [Collections](https://jekyllrb.com/docs/collections/) 找到更多关于集合的信息。 |
| **type** | item, brief, grid | TeXt 支持三种文章列表类型,每种类型都对应着一些配置,你可以在 [这里](https://kitian616.github.io/jekyll-TeXt-theme/samples.html#articles-layout) 看到相关的示例。 |
| **size** | md, sm | 当 type 为 `grid` 时有效。 |
| **article_type** | BlogPosting | 当 type 为 `normal` 时有效。 |
| **show_cover** | true (default), false | 当 type 为 `normal` 时有效。 在设置改参数为 `true` 前,你需要给集合里的每篇文章设置封面, 参考 [Page 布局](#page-layout)的 `cover` 配置项。 |
| **cover_size** | lg, md, sm | 当 type 为 `normal` 时有效。 |
| **show_excerpt** | true, false (default) | 当 type 为 `normal` 时有效, 参考下面 [excerpt_type](#excerpt_type) 章节。 |
| **excerpt_type** | text, html | 当 type 为 `normal` 时有效。 |
| **show_readmore** | true, false (default) | 当 type 为 `normal` 时有效。 |
| **show_info** | true, false (default) | 当 type 为 `normal``brief` 时有效。 |
### articles.excerpt_type
文章列表中文章项的摘要有两种模式——TEXT 模式和 HTML 模式。
| 模式名称 | 描述 |
| --- | --- |
| **text** | 此时摘要为纯文本,会过滤掉一切非文本元素(标题,链接,列表,表格,图片等等),且截取前 350 个字符。 |
| **html** | 此时摘要为 HTML 文档,与文章内容一致,并且 **默认展示整篇文章的内容**。若想控制摘要内容,需要在文章中想要显示到的地方加上 `<!--more-->`,详情请戳 [这里](https://jekyllrb.com/docs/posts/#post-excerpts)。 |
对于 Home 页,你可以像这样把 `excerpt_type` 设置为 `HTML`
```yaml
layout: home
articles:
excerpt_type: html
```
## Home 布局
继承于 Articles 布局。
## Archive 布局
继承于 Page 布局。
## Landing 布局
继承于 Page 布局。
| 配置项 | 可选值 | 描述 |
| --- | --- | --- |
| **data** | `!!map` | |
## 404 布局
继承于 Page 布局。

View File

@ -1,30 +0,0 @@
---
title: Logo 和 Favicon
permalink: /docs/zh/logo-and-favicon
key: docs-logo-and-favicon-zh
---
## Logo
<p>TeXt 使用 <span>{% include svg/logo.svg %}</span> 作为它的 Logo你可以通过替换 <em>_includes/svg/logo.svg</em> 来设置你的 Logo。</p>
## Favicon
TeXt 推荐使用 [RealFaviconGenerator](https://realfavicongenerator.net/) 来生成 Favicon。
打开 [RealFaviconGenerator](https://realfavicongenerator.net/) 后点击“Select your Favicon picture”选择图片进入下一步。
![Select your Favicon picture](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/realfavicongenerator-select-favicon-picture.jpg)
图标设置完成后,你需要告诉生成器 Favicon 文件的网站路径TeXt 将他们放在了 */assets* 目录。
推荐将 Favicon 文件放在网站的根目录下。
{:.warning}
![Select your Favicon path](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/realfavicongenerator-path.jpg)
完成后点击“Generate your Favicons and HTML code”进入到最后一步。
![Result](https://raw.githubusercontent.com/kitian616/jekyll-TeXt-theme/master/docs/assets/images/realfavicongenerator-result.jpg)
下载生成的 favicon 包,解压文件到你方才填写的路径,将 HTML 代码替换到 *_includes/head/favicon.html* 文件中。

View File

@ -1,34 +0,0 @@
---
title: 作者
permalink: /docs/zh/authors
key: docs-authors-zh
---
文章或页面的作者默认为在 *_config.yml* 中配置的 `author`,当然你可以通过 YAML 头信息来指定特定文章的作者。
首先你需要有一个 *_data/authors.yml* 的文件,参考以下格式来增加作者信息。其可用参数和 *_config.yml* 中的 `author` 项的参数一致type, name, url, avatar, bio, email, facebook 等)。
```yml
Tian Qi:
name : Tian Qi
url : https://kitian616.github.io
avatar : https://wx3.sinaimg.cn/large/73bd9e13ly1fjkqy66hl8j208c08c0td.jpg
bio : Author of TeXt.
email : kitian616@outlook.com
facebook : # "user_name" the last part of your profile url, e.g. https://www.facebook.com/user_name
twitter : kitian616 # "user_name" the last part of your profile url, e.g. https://twitter.com/user_name
weibo : 234695683 # "user_id" the last part of your profile url, e.g. https://www.weibo.com/user_id/profile?...
googleplus: 101827554735084402671 # "user_id" the last part of your profile url, e.g. https://plus.google.com/u/0/user_id
telegram : # "user_name" the last part of your profile url, e.g. https://t.me/user_name
medium : # "user_name" the last part of your profile url, e.g. https://medium.com/user_name
zhihu : # "user_name" the last part of your profile url, e.g. https://www.zhihu.com/people/user_name
douban : # "user_name" the last part of your profile url, e.g. https://www.douban.com/people/user_name
linkedin : # "user_name" the last part of your profile url, e.g. https://www.linkedin.com/in/user_name
github : kitian616 # "user_name" the last part of your profile url, e.g. https://github.com/user_name
npm : # "user_name" the last part of your profile url, e.g. https://www.npmjs.com/~user_name
```
将在 *authors.yml* 中定义的作者作为某篇文章或页面的作者以覆盖 `site.author` 全局作者。
---
author: Tian Qi
---

View File

@ -1,25 +0,0 @@
---
title: 国际化
permalink: /docs/zh/i18n
key: docs-i18n-zh
---
TeXt 把 UI 元素的文字整理成一系列的翻译标识统一的放置在 *_data/locale.yml* 中,这样能够比较方便添加不同语言的支持。
通过 `titles` 配置项可以给文章布局和导航定义定义多语言标题TeXt 默认定义了很多这样的标题,它们分别位于 *_data/navigation**_layouts/archive**_layouts/home* 和 *about.md* 中。
<!-- 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 |
<!-- @end locale config -->
你可以在 [这里](https://kitian616.github.io/jekyll-TeXt-theme/samples.html#languages) 找到不同语言的示例。

View File

@ -1,38 +0,0 @@
---
title: 撰写博客
permalink: /docs/zh/writing-posts
key: docs-writing-posts-zh
---
在[目录结构](http://jekyllcn.com/docs/structure/)介绍中说明过,**所有的文章都在 */_posts* 文件夹中**。这些文件可以用 Markdown 或 HTML 编写。只要文件中有 YAML 头信息,它们就会从源格式转化成 HTML 页面,从而成为你的静态网站的一部分。
<!--more-->
## 创建文章
发表一篇新文章,你所需要做的就是在 */_posts* 文件夹中创建一个新的文件。文件名的命名非常重要。Jekyll 要求一篇文章的文件名遵循下面的格式:
年-月-日-标题.MARKUP
下面是一些合法的文件名的例子:
2011-12-31-new-years-eve-is-awesome.md
2012-09-12-how-to-write-a-blog.markdown
## 内容相关
所有博客文章顶部必须有一段 YAML 头信息(YAML front-matter)。
为了提高文章的阅读和书写体验TeXt 在 Markdown 原有的基础上做了一些增强。
### YAML 头信息
---
layout: article
title: Document - Writing Posts
mathjax: true
---
`---` 之间你可以设置属性的值,可以把它们看作页面的配置,这些配置会覆盖在 *_config.yml* 文件中设置的全局配置。
除去 Jekyll 自定义的变量外TeXt 也定义了一些额外的变量,详情请戳[布局](https://kitian616.github.io/jekyll-TeXt-theme/docs/zh/layouts)。

View File

@ -1,171 +0,0 @@
---
title: Markdown 增强
permalink: /docs/zh/markdown-enhancements
key: docs-markdown-enhancements-zh
---
你需要在 *_config.yml* 或 YAML 头信息中设置相关的属性为 `true` 来开启对应的功能。
| 增强项 | 描述 |
| --------------- | ----------- |
| **Mathjax** | 在文章中方便的加入数学公式,使用 MathML、LaTeX 和 ASCIIMathML 语法 | [示例](https://kitian616.github.io/jekyll-TeXt-theme/post/2017/07/07/mathjax.html) |
| **Mermaid** | 在文章中方便的加入流程图 | [示例](https://kitian616.github.io/jekyll-TeXt-theme/post/2017/06/06/mermaid.html) |
| **Chart** | 在文章中方便的加入可交互的图表 | [示例](https://kitian616.github.io/jekyll-TeXt-theme/post/2017/05/05/chart.html) |
## Mathjax
When $$a \ne 0$$, there are two solutions to $$ax^2 + bx + c = 0$$ and they are
$$x_1 = {-b + \sqrt{b^2-4ac} \over 2a}$$
$$x_2 = {-b - \sqrt{b^2-4ac} \over 2a} \notag$$
**markdown:**
```tex
When $$a \ne 0$$, there are two solutions to $$ax^2 + bx + c = 0$$ and they are
$$x_1 = {-b + \sqrt{b^2-4ac} \over 2a}$$
$$x_2 = {-b - \sqrt{b^2-4ac} \over 2a} \notag$$
```
**当 MathJax 激活后**,你可以设置 `mathjax_autoNumber: true` 让公式自动编号,你可以使用 \notag 或者 \nonumber 阻止某条公式自动编号。
{:.info}
## Mermaid
```mermaid
graph TB;
A[Do you have a problem in your life?]
B[Then don't worry]
C[Can you do something about it?]
A--no-->B;
A--yes-->C;
C--no-->B;
C--yes-->B;
```
**markdown:**
```mermaid
graph TB;
A[Do you have a problem in your life?]
B[Then don't worry]
C[Can you do something about it?]
A--no-->B;
A--yes-->C;
C--no-->B;
C--yes-->B;
```
[Mermaid](https://mermaidjs.github.io/) 支持以下三种示意图:
- [Flowchart](https://mermaidjs.github.io/flowchart.html)
- [Sequence Diagram](https://mermaidjs.github.io/sequenceDiagram.html)
- [Gant Diagram](https://mermaidjs.github.io/gantt.html)
## Chart
```chart
{
"type": "line",
"data": {
"labels": [
"January",
"February",
"March",
"April",
"May",
"June",
"July"
],
"datasets": [
{
"label": "# of bugs",
"fill": false,
"lineTension": 0.1,
"backgroundColor": "rgba(75,192,192,0.4)",
"borderColor": "rgba(75,192,192,1)",
"borderCapStyle": "butt",
"borderDash": [],
"borderDashOffset": 0,
"borderJoinStyle": "miter",
"pointBorderColor": "rgba(75,192,192,1)",
"pointBackgroundColor": "#fff",
"pointBorderWidth": 1,
"pointHoverRadius": 5,
"pointHoverBackgroundColor": "rgba(75,192,192,1)",
"pointHoverBorderColor": "rgba(220,220,220,1)",
"pointHoverBorderWidth": 2,
"pointRadius": 1,
"pointHitRadius": 10,
"data": [
65,
59,
80,
81,
56,
55,
40
],
"spanGaps": false
}
]
},
"options": {}
}
```
**markdown:**
```chart
{
"type": "polarArea",
"data": {
"datasets": [
{
"data": [
11,
16,
7,
3,
14
],
"backgroundColor": [
"#FF6384",
"#4BC0C0",
"#FFCE56",
"#E7E9ED",
"#36A2EB"
],
"label": "My dataset"
}
],
"labels": [
"Red",
"Green",
"Yellow",
"Grey",
"Blue"
]
},
"options": {}
}
```
[Chart.js](http://www.chartjs.org/docs/latest/) 支持以下 7 种图表:
- [Line Chart](http://www.chartjs.org/docs/latest/charts/line.html)
- [Bar Chart](http://www.chartjs.org/docs/latest/charts/bar.html)
- [Radar Chart](http://www.chartjs.org/docs/latest/charts/radar.html)
- [Polar Area Chart](http://www.chartjs.org/latest/charts/polar.html)
- [Pie Chart](http://www.chartjs.org/docs/latest/charts/doughnut.html)
- [Doughnut Chart](http://www.chartjs.org/docs/latest/charts/doughnut.html)
- [Bubble Chart](http://www.chartjs.org/docs/latest/charts/bubble.html)

Some files were not shown because too many files have changed in this diff Show More