本文是写给完全未用过 Ruby 乃至命令行工具者的。对于一般的开发者,Jekyll 官方文档的相关内容已然足够。
本文为钱院学辅技术小组公开课专门编写。
Jekyll 是由 Ruby 语言开发而成的网站搭建工具,其可完成由 Markdown 代码仓库(及若干自定义的 CSS/Sass 样式表、HTML 模板等)生成网站的流程。GitHub Pages 服务即内置了一套附有若干插件的 Jekyll 工具,用于直接在代码仓库的基础上生成网站。
安装 Ruby 环境
为了在本地调试由 Jekyll 生成的网站效果,有必要在自己的系统上安装 Jekyll,当然首先应该安装其所需要的 Ruby 环境。对于类 Unix 系统,这并不是一个问题,例如在 Ubuntu 中只需要以下几行命令:
sudo apt-get install ruby-full build-essential zlib1g-dev # 安装 ruby 环境
gem install jekyll bundler # 安装 Jekyll 与 Bundler
但对于 Windows 用户(往往是此方面的小白)来说,以上两步都有问题。首先是安装 Ruby,Windows 上自然没法只靠一条命令就装好 Ruby 环境[1],为此有以下两种选择:
- 在这里下载 RubyInstaller,安装即可。
- 首先安装 Windows Subsystem for Linux(WSL,Windows 上的 Linux 子系统),然后在其中通过包管理器安装 Ruby。
前者的问题在于国内下载时的网速奇慢,后者的问题在于需要使用陌生的 Linux 系统。因此,两条途径皆有实际的困难。这里先提供两条对策:
-
点这里通过百度网盘下载 RubyInstaller,验证码:
rzxe
。当然,这个链接(是我上传的)也许很快就会因为版本更新而过时,所以你可能需要去寻找其他的途径下载 RubyInstaller。 - 点这里通过视频了解如何安装 WSL,之后的步骤就像前面所说的一样,运行两行命令即可。
Ruby 环境安装完成之后,可以打开任意一种命令行工具(包括命令提示符 cmd、powershell、Git Bash 等等),用 ruby -v
命令检查 Ruby 是否正确安装。正确安装的情况下,该命令会返回你所安装的 Ruby 版本信息。
用 Bundler 安装 Jekyll
Ruby 环境有了之后,再安装 Jekyll 就稍微简单一些了。这里可能有两种情况:一种是使用原生的 Jekyll,并且没有使用任何插件;一种是使用了带插件的 Jekyll——比如在 GitHub Pages 上生成的网站(使用 github-pages
这个 Gem),这时代码仓库中需要有一个名为 Gemfile
的文件来指定插件的使用情况。后者占绝大多数,因此这里说后一种情况。
基本的步骤包括:
- Ruby 采用名为 Gem 的包管理器来安装程序。用
gem install jekyll bundler
命令,分别安装 Jekyll[2] 与一个名为 Bundler 的程序——后者用于自动安装其他所需的程序。 - 在命令行中切换到你的网站仓库内(通常使用
cd
命令完成); - 运行
bundle install
命令——这将使得 Bundler 程序为你的网站安装所需要的各种必要工具。 - 最后,运行
bundle exec jekyll serve
命令,这将使得 Jekyll 在 Bundler 的保障下开始运行,开启一个「本地服务器」预览网站。 -
不要关闭命令行程序。 打开浏览器,在浏览器中输入
127.0.0.1:4000
或localhost:4000
,你就能看到由你编写的代码所生成的网站。
一次正常的预览流程如下图所示,图中标注出了你所需要做的各项工作。这里使用的是 Git Bash,你当然可以使用命令提示符或 Powershell 来执行相关命令。(其中 1 -- 3 属于准备工作,对每个代码仓库只需要施行一次)
在安装、运行过程中,可能出现以下问题:
- 命令运行速度极慢,长时间没有进展:通常情况下是因为网络。Gem 的软件源在国内比较难以访问,因此你可能需要像其他各类包管理器一样选择镜像。点这里查看由 Ruby China 提供的 Gem 镜像及使用方法。
- 运行 Jekyll 时,一个名为
sass
的程序提示有 GBK 字符,不能正常编译 Sass 文件:这是因为你在安装 RubyInstaller 时没有勾选「默认使用 UTF-8 编码」的选项。请重新安装 RubyInstaller,或为出现问题的文件临时调整编码。或者,可以删除掉文件中的中文字符(它们一般都是注释,没用)。