Demo | English (Beta)

TeXt is a succinct theme for blogging.

TeXt 是针对博客的一款简洁的主题，它虽然简洁但并不简单。它参考了 iOS 11 的风格，有大而突出的标题和圆润的按钮及卡片。

• 响应式
• 分页（jekyll-paginate）
• 文章目录
• 文章标签
• 搜索（标题）
• 阅读次数统计（LeanCloud）
• Emoji（Jemoji）
• 评论（Disqus, gitalk）
• Google Analytics
• 联系方式设置（Email, Facebook, Twitter, 微博, 知乎……）
• Web 语意化
• 网站图标的自动化工具（gulp-svg2png, gulp-to-ico）
• Color Theme
• 数学公式（MathJax）
• 流程图， 序列图，甘特图（mermaid）
• 柱状图，折线图，饼图，雷达图（chartjs）
• RSS（jekyll-feed）
• 多语言支持（English | 简体中文 | 繁體中文）

下面简要的介绍下使用的方法，当然如果你对 Jekyll 比较了解可以直接看后面的高级部分，这是该主题增加的一些特有功能。

最简单的方法是直接 Fork 到你的 GitHub 仓库然后更改其名称为 <username>.github.io，稍等一会儿访问 https://<username>.github.io 即可看到一个空的博客页，接下来你可以把它 Clone 到本地修改后提交。

当然你也可以在 Releases 页面 下载最新版本源码，或直接 Clone 代码到本地。

另外，因为每个版本都是作为一个 Gem 发布的，所以你也可以通过 Jekyll 的主题系统安装该主题，这种方式可以很方便的升级保持最新，但不支持 GitHub 的自动编译，详见 Jekyll: 主题。项目的 ./test 目录就是一个使用主题系统的例子。

在 ./_config.yml 文件里按照说明加上你的信息，例如你的名字和联系方式，网站的标题和描述等等。

在 ./about.md 中写上你的简单介绍，例如我叫小明之类的。

使用 Markdown 编写文章，位于 ./_posts 目录（需要自行创建）下，文件名采用日期 + 标题的形式，形如 2017-02-02-Very-Long-Title，可参考 ./test/_posts 目录。

可以在头信息里设置文章的一些基本信息，包括标题、发布时间和标签等。当然，如果你不设置标题和发布时间，系统会使用文件名中的标题和发布时间，详见 Jekyll: 头信息。当然，该主题在原有的基础上增加了一些属性，这在后面会讲到。

该主题的摘要有两种模式——TEXT 模式和 HTML 模式。 当 ./_config.yml 配置项 excerpt_type 的值为 text 时是 TEXT 模式，为 html 时是 HTML 模式，默认为 TEXT 模式。

TEXT 模式的摘要为纯文本，会过滤掉一切非文本元素（标题，链接，列表，表格，图片等等），且截取前 350 个字符。

HTML 模式的摘要为 HTML 文档，与文章内容一致，并且 默认展示整篇文章的内容。若想控制摘要内容，需要在文章中想要显示到的地方加上 <!--more-->，详见 Jekyll: 文章摘要。

提示：为了首页更好的展示效果，个人还是推荐使用 HTML 模式，并自己在文章中加上 <!--more-->。

具体可参考 Jekyll: 安装。

请确保你的电脑上配置好了 Ruby 开发环境。(ruby, bundle, Command Line Tools(macOS) ...)

首先安装 github-pages（包含了 Jekyll 以及一些插件），在项目根目录执行 bundle install 即可安装。

推荐安装 Node.js 环境，可以获得更好的开发体验。

如果你安装了 Node.js 环境，只需要在项目根目录运行 npm run dev 即可启动本地服务。

如果没有安装 Node.js 环境，则是：

bundle exec jekyll serve -H 0.0.0.0

命令执行成功后在浏览器中访问 https://localhost:4000/ 即可看到页面。

推荐部署到 GitHub Pages 上，简单而免费，详见 Jekyll: GitHub Pages。

如果你是下载或者 Clone 的源码，那么你需要在 GitHub 上建立一个 Repository，然后把项目代码 push 到其对应的分支上（如果以 <username>.github.io 命名则对应分支为 master ，其他的为 gh-pages，详见 Github Pages: Configuring a publishing source for GitHub Pages）。

如果你是通过 Jekyll 的主题系统安装的，那么你需要把本地编译好的代码 push 到上文所说的对应分支上。

当然你也可以部署到到其他地方。

该主题支持 English、简体中文和繁體中文，只需在 ./_config.yml 中设置对应 lang 项即可。设置后整个网站的主题文字（导航，阅读更多，文章数统计，日期格式，文章协议等等）会变为设置的语言，多语言的配置文件为 ./_data/locale.yml，你可以自由的修改和增加语言。

另外，该主题也支持对某篇文章（页面）单独设置语言，只需在 Markdown 或页面 HTML 文件的头信息中设置 lang 项，其优先级高于 ./_config.yml 中设置的值。设置后该文章（页面）的主题文字会变为头信息中设置的语言。

提示：当前的 lang 值可选值为 en(English), zh(简体中文), zh-Hans(简体中文), zh-Hant(繁體中文)。

颜色主题位于文件夹 ./_sass/colors 中，修改 ./_config.yml 中的 text_color_theme 项为以下值即可更换颜色主题，默认主题为 default。

default	dark	forest

ocean	chocolate	orange

更多颜色主题敬请期待。

该主题自带了一个“银杏叶”图标，你可以把它替换为自己的图标。网站的图标位于 ./favicon.ico 和 ./assets/images/logo 目录下。你会看到 logo 目录中有很多的 png 文件和一个 svg 矢量图文件。那些 png 图片实际上就是根据 svg 矢量图生成的不同大小的图片，这些图片是一些场景可能会用到的大图标，像 iOS 和 Android 的固定到屏幕和 Windows 10 的磁贴。

该主题提供了一个自动化脚本能将 svg 矢量图自动生成 favicon 和 png 文件。你所要做的是：

1. 安装 Node.js 环境

2. 在项目根目录执行 npm i 命令

3. 替换 ./assets/images/logo 目录下的 logo.svg 文件

4. 执行 npm run artwork 命令，此时 favicon 和 png 便会替换为新 logo.svg 生成的文件

当然如果要追求各个尺寸下图标的显示效果，那还得对不同尺寸的图片进行修改和优化。

目前支持 Disqus 和 gitalk 评论系统，优先使用 Disqus。

在 ./_config.yml 文件的 disqus.shortname 项填上你在 Disqus 上为网站建立的 site 对应的 shortname 即可，需要注意的是 Disqus 在大陆是无法直接访问的。

在 ./_config.yml 文件的 gitalk 的子项（clientID,clientSecret, repository, owner, admin）填上 gitalk 的对应参数 即可，详见 gitalk 中文文档。

注意：使用评论系统必须在文章的头信息中设置 key 值（可用字符集：字母、数字 及 - _ : .）。

在 ./_config.yml 文件 leancloud 的 app_id、app_key、app_class 项分别填上你在 LeanCloud 为网站建立的应用的对应参数。

注意：使用阅读量统计必须在文章的头信息中设置 key 值（可用字符集：字母、数字 及 - _ : .）。

在 ./_config.yml 文件的 ga_tracking_id 项填上你在 Google Analytics 上为网站建立的媒体资源对应的跟踪 ID。

除了 Jekyll 官方的头信息外，该主题增加了一些头信息。

在 ./_includes/icon/social 目录下有很多的社交产品图标，例如 Behance、Flickr、QQ、微信等，方便修改和使用。

• Demo
• Qi's blog