Jekyll 是一个简单的博客形态的静态站点生产机器。 它有一个模版目录,其中包含原始文本格式的文档,通过一个转换器(如 Markdown) 和我们的 Liquid 渲染器转化成一个完整的可发布的静态网站,你可以发布在任何你喜爱的服务器上。 Jekyll 也可以运行在 GitHub Page 上,也就是说, 你可以使用 GitHub 的服务来搭建你的项目页面、博客或者网站,而且是完全免费的。
在 Jekyll 中的配置文件是 _config.yml
。为了描述方便,在以下说明中,将称为 主题配置文件。
安装 NexT
确保已安装`Ruby 2.1.0` 或更高版本:
$ ruby --version
安装Bundler
:
$ gem install bundler
下载 NexT 主题:
$ git clone https://github.com/Simpleyyt/jekyll-theme-next.git
$ cd jekyll-theme-next
安装依赖:
$ bundle install
运行 Jekyll:
$ bundle exec jekyll server
此时即可使用浏览器访问 http://localhost:4000
,检查站点是否正确运行。
当你看到站点的外观与下图所示类似时即说明你已成功安装 NexT 主题。这是 NexT 默认的 Scheme —— Muse
现在,你已经成功安装并启用了 NexT 主题。下一步我们将要更改一些主题的设定,包括个性化以及集成第三方服务。
主题设定
选择 Scheme
Scheme 是 NexT 提供的一种特性,借助于 Scheme,NexT 为你提供多种不同的外观。同时,几乎所有的配置都可以 在 Scheme 之间共用。目前 NexT 支持三种 Scheme,他们是:
- Muse - 默认 Scheme,这是 NexT 最初的版本,黑白主调,大量留白
- Mist - Muse 的紧凑版本,整洁有序的单栏外观
- Pisces - 双栏 Scheme,小家碧玉似的清新
Scheme 的切换通过更改 主题配置文件,搜索 scheme 关键字。
你会看到有三行 scheme 的配置,将你需用启用的 scheme 前面注释 #
去除即可。
#scheme: Muse
#scheme: Mist
scheme: Pisces
设置 语言
编辑 主题配置文件,
将 language
设置成你所需要的语言。建议明确设置你所需要的语言,例如选用简体中文,配置如下:
language: zh-Hans
目前 NexT 支持的语言如以下表格所示:
语言 | 代码 | 设定示例 |
---|---|---|
English | en |
language: en |
简体中文 | zh-Hans |
language: zh-Hans |
Français | fr-FR |
language: fr-FR |
Português | pt |
language: pt or language: pt-BR |
繁體中文 | zh-hk 或者 zh-tw |
language: zh-hk |
Русский язык | ru |
language: ru |
Deutsch | de |
language: de |
日本語 | ja |
language: ja |
Indonesian | id |
language: id |
Korean | ko |
language: ko |
设置 菜单
菜单配置包括三个部分,第一是菜单项(名称和链接),第二是菜单项的显示文本,第三是菜单项对应的图标。 NexT 使用的是 Font Awesome 提供的图标, Font Awesome 提供了 600+ 的图标,可以满足绝大的多数的场景,同时无须担心在 Retina 屏幕下 图标模糊的问题。
编辑 主题配置文件,修改以下内容:
-
设定菜单内容,对应的字段是
menu
。 菜单内容的设置格式是:item name: link
。其中item name
是一个名称,这个名称并不直接显示在页面上,她将用于匹配图标以及翻译。菜单示例配置menu: home: / archives: /archives #about: /about #categories: /categories tags: /tags #commonweal: /404.html
NexT 默认的菜单项有:
键值 设定值 显示文本(简体中文) home home: /
主页 archives archives: /archives
归档页 categories categories: /categories
分类页 tags tags: /tags
标签页 about about: /about
关于页面 commonweal commonweal: /404.html
公益 404 -
设置菜单项的显示文本。在第一步中设置的菜单的名称并不直接用于界面上的展示。Jekyll 在生成的时候将使用 这个名称查找对应的语言翻译,并提取显示文本。这些翻译文本放置在 NexT 主题目录下的
_data/languages/{language}.yml
({language}
为你所使用的语言)。以简体中文为例,若你需要添加一个菜单项,比如
something
。那么就需要修改简体中文对应的翻译文件_data/languages/zh-Hans.yml
,在menu
字段下添加一项:menu: home: 首页 archives: 归档 categories: 分类 tags: 标签 about: 关于 search: 搜索 commonweal: 公益404 something: 有料
-
设定菜单项的图标,对应的字段是
menu_icons
。 此设定格式是item name: icon name
,其中item name
与上一步所配置的菜单名字对应,icon name
是 Font Awesome 图标的 名字。而enable
可用于控制是否显示图标,你可以设置成false
来去掉图标。菜单图标配置示例menu_icons: enable: true # Icon Mapping. home: home about: user categories: th tags: tags archives: archive commonweal: heartbeat
在菜单图标开启的情况下,如果菜单项与菜单未匹配(没有设置或者无效的 Font Awesome 图标名字) 的情况下,NexT 将会使用 作为图标。
请注意键值(如
home
)的大小写要严格匹配
设置 侧栏
默认情况下,侧栏仅在文章页面(拥有目录列表)时才显示,并放置于右侧位置。
可以通过修改 主题配置文件 中的
sidebar
字段来控制侧栏的行为。侧栏的设置包括两个部分,其一是侧栏的位置,
其二是侧栏显示的时机。
-
设置侧栏的位置,修改
sidebar.position
的值,支持的选项有:- left - 靠左放置
- right - 靠右放置
目前仅 Pisces Scheme 支持
position
配置。影响版本5.0.0及更低版本。sidebar: position: left
-
设置侧栏显示的时机,修改
sidebar.display
的值,支持的选项有:post
- 默认行为,在文章页面(拥有目录列表)时显示always
- 在所有页面中都显示hide
- 在所有页面中都隐藏(可以手动展开)remove
- 完全移除
sidebar: display: post
已知侧栏在
use motion: false
的情况下不会展示。 影响版本5.0.0及更低版本。
设置 头像
编辑 主题配置文件,
修改字段 avatar
, 值设置成头像的链接地址。其中,头像的链接地址可以是:
地址 | 值 |
---|---|
完整的互联网 URI |
http://example.com/avatar.png
|
站点内的地址 |
将头像放置主题目录下的
或者 放置在 |
avatar: http://example.com/avatar.png
设置 作者昵称
编辑 主题配置文件, 设置 author
为你的昵称。
站点描述
编辑 主题配置文件,
设置 description
字段为你的站点描述。站点描述可以是你喜欢的一句签名:)
集成常用的第三方服务
百度统计
- 登录 百度统计, 定位到站点的代码获取页面
-
复制
hm.js?
后面那串统计脚本 id,如: -
编辑 主题配置文件,
修改字段
baidu_analytics
字段,值设置成你的百度统计脚本 id。
阅读次数统计(LeanCloud) 由 Doublemine 贡献
Algolia 搜索
详细的配置请参考: 第三方服务 - Algolia