Skip to content

💎 🐳 A super customizable Jekyll theme for personal site, team site, blog, project, documentation, etc.

License

Notifications You must be signed in to change notification settings

z5j2y3/BY2HIT.github.io

Repository files navigation

GitHub release license

TeXt Theme

TeXt is a succinct theme for blogging.

TeXt 是针对博客的一款简洁的主题,它虽然简洁但并不简单。

该主题模仿了 iOS 11 的风格,它有大而突出的标题和圆润的按钮和卡片,它主要有以下功能:

  • 响应式
  • 分页
  • 文章目录(使用了 TOC 插件,nice work !)
  • 文章标签
  • 阅读次数统计(LeanCloud
  • Emoji(EmojiOne
  • 评论(Disqus
  • Google Analytics
  • 联系方式设置(Email, Facebook, Twitter, 微博, 知乎……)
  • Web 语意化
  • 网站图标的自动化工具
  • RSS

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

安装

请确保你的电脑上安装了 Ruby 开发环境。( Linux 和 macOS 自带)

首先安装 github-pages,在项目根目录执行 bundle install 即可安装。

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

配置

在 _config.yml 文件里按照说明加上你的信息,例如网站的协议加域名,例如 https://www.domain.com,这个是必须填的。另外还有你的名字和联系方式,网站的标题和描述等等。

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

写博客

使用 Markdown 编写文章,位于 _posts 目录,文件名采用日期 + 标题的形式。(见示例文章)

可以在头信息里设置文章的一些基本信息,包括时间、文件夹和标签等,具体详见 Jekyll: 头信息。当然,该主题在原有的基础上增加了一些属性,这在后面会讲到。

本地服务器

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

如果不想安装 Node.js 环境,则需要以下两步:

启动编译服务,在文件改变时会自动重新编译:

bundle exec jekyll build --watch

启动静态服务器:

bundle exec jekyll serve -H 0.0.0.0

在浏览器中访问 http://localhost:4000/ 即可看到页面。

部署

推荐部署到 GitHub Pages 上,简单而免费,详见 Jekyll: GitHub Pages,当然你也可以部署到到其他地方。

高级

网站图标

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

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

  1. 安装 Node.js 环境

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

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

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

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

评论系统

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

注意:使用评论系统必须在文章的头信息中设置 key 值。

Google Analytics

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

阅读量统计

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

注意:使用阅读量统计必须在文章的头信息中设置 key 值。

Markdown 头信息增强

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

变量名称 可选值 描述
key 评论系统和阅读量统计使用的文章标识符,如果未设置则评论和统计无效
picture_frame shadow 该文章的图片框样式,如果为 shadow 则图片带有阴影边框
modify_date 该文章的修改时间,不影响首页文章排序(date 代表发表时间,会影响文章排序)
comment true/false 该文章是否能够评论,默认为 true(当然你也可以通过不设置 key 来实现,但是这样的话统计也失效了)

颜色主题

颜色主题位于文件夹 _sass/colors 中,目前有 2 个主题:default 和 dark。修改 _sass/settings/colors.scss 的 @import 路径即可修改主题,默认主题为 default。

Dark Color Theme

更多颜色主题敬请期待。

其他资源

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

示例

在线访问:Qi's blog

GitHub:https://github.com/kitian616/kitian616.github.io/

About

💎 🐳 A super customizable Jekyll theme for personal site, team site, blog, project, documentation, etc.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • SCSS 40.9%
  • HTML 35.4%
  • JavaScript 23.0%
  • Other 0.7%