配置选项
下表列出了 Jekyll 的可用设置,以及控制它们的各种 选项
(在配置文件中指定)和 标志
(在命令行中指定)。
全局配置
设置 | 选项 和 标志 |
---|---|
网站源 更改 Jekyll 将读取文件的目录 |
|
网站目标 更改 Jekyll 将写入文件的目录 |
|
安全 禁用 非白名单插件、磁盘缓存,并忽略符号链接。 |
|
禁用磁盘缓存 4.1.0 禁用内容到磁盘的缓存,以便跳过在源处创建 |
|
忽略主题配置 4.1.0 Jekyll 4.0 开始允许主题捆绑 |
|
排除 从转换中排除目录和/或文件。这些排除项相对于网站的源目录,且不能位于源目录之外。
|
|
包含 强制在转换中包含目录和/或文件。`htaccess` 是一个很好的示例,因为点文件在默认情况下被排除在外。使用 Jekyll 4,`include` 配置选项条目会覆盖 `exclude` 选项条目。 |
|
保留文件 在覆盖网站目标时,保留选定的文件。对于未由 jekyll 生成的文件非常有用;例如,由构建工具生成的资产或文件。路径相对于 `destination`。 |
|
时区 设置网站生成的时区。这会设置 `TZ` 环境变量,Ruby 使用该变量来处理时间和日期的创建和操作。IANA 时区数据库 中的任何条目都是有效的,例如 `America/New_York`。可以在 此处 找到所有可用值列表。在本地计算机上提供服务时,默认时区由操作系统设置。但在远程主机/服务器上提供服务时,默认时区取决于服务器的设置或位置。 |
|
编码 按名称设置文件的编码(仅适用于 Ruby 1.9 或更高版本)。从 2.0.0 开始,默认值为 `utf-8`,在 2.0.0 之前为 `nil`,这会产生 Ruby 的 `ASCII-8BIT` 默认值。可以通过命令 `ruby -e 'puts Encoding::list.join("\n")'` 显示可用编码。 |
|
默认值 设置 front matter 变量的默认值。 |
请参阅 下方 |
在网站构建时清理目标文件夹
在默认情况下,在构建网站时会自动清理 `<destination>` 的内容。将删除未由您的网站创建的文件或文件夹。可以通过在 `<keep_files>` 配置指令中指定一些文件来保留这些文件。
不要将 <destination>
用作重要位置;而是将其用作临时区域,并将文件从那里复制到您的 Web 服务器。
构建命令选项
设置 | 选项 和 标志 |
---|---|
重新生成 在文件修改时启用网站的自动重新生成。 |
|
配置 指定配置文件,而不是自动使用 |
|
插件 指定插件目录,而不是自动使用 |
|
布局 指定布局目录,而不是自动使用 |
|
草稿 处理并渲染草稿帖子。 |
|
环境 在构建中使用特定的环境值。 |
|
未来 发布具有未来日期的帖子或集合文档。 |
|
未发布 渲染标记为未发布的帖子。 |
|
LSI 生成相关帖子的索引。需要 classifier-reborn 插件。 |
|
限制帖子 限制要解析和发布的帖子数量。 |
|
强制轮询 强制 watch 使用轮询。 |
|
详细输出 打印详细输出。 |
|
静默输出 在构建期间使 Jekyll 的正常输出静默。 |
|
日志级别 在 debug、info、warn 或 error 中指定日志级别。 |
|
增量构建 启用实验性 增量构建 功能。增量构建仅重新构建已更改的帖子和页面,从而为大型网站带来显著的性能提升,但在某些情况下也可能中断网站生成。 |
|
禁用 bundle require 禁用在 `:jekyll_plugins` Gemfile 中需要 gem 的需求 |
|
Liquid 分析器 生成 Liquid 渲染配置文件,以帮助您识别性能瓶颈。 |
|
严格的前置内容 如果页面的前置内容中存在 YAML 语法错误,则导致构建失败。 |
|
基本网址 从给定的基本网址提供网站服务。 |
|
跟踪 当错误发生时显示完整的回溯。 |
|
提供命令选项
除了以下选项外,serve
子命令还可以接受 build
子命令的任何选项,这些选项随后应用于在提供网站服务之前发生的网站构建。
设置 | 选项 和 标志 |
---|---|
本地服务器端口 在给定的端口上监听。默认值为 `4000`。 |
|
本地服务器主机名 在给定的主机名上监听。默认值为 `localhost`。 |
|
实时重新加载 当编辑其内容时,在浏览器中自动重新加载页面。 |
|
实时重新加载忽略 LiveReload 忽略的文件 glob 模式。 |
|
实时重新加载最小/最大延迟 自动重新加载页面之前的最小/最大延迟。 |
|
实时重新加载端口 LiveReload 监听的端口。 |
|
打开网址 在浏览器中打开网站的网址。 |
|
分离 从终端分离服务器。 |
|
跳过初始网站构建 跳过在启动服务器之前发生的初始网站构建。 |
|
显示目录列表 显示目录列表,而不是加载索引文件。 |
|
X.509 (SSL) 私钥 SSL 私钥,存储或符号链接在网站源中。 |
|
X.509 (SSL) 证书 SSL 公共证书,存储或符号链接在网站源中。 |
|
不要在配置文件中使用制表符
这将导致解析错误,或者 Jekyll 将恢复到默认设置。请改用空格。