Параметры конфигурации

В таблицах ниже перечислены доступные настройки Jekyll, а также различные options (указанные в файле конфигурации) и flags (указанные в командной строке), которые их контролируют.

Глобальная конфигурация

Настройка Параметры и Флаги

Настройка	Параметры и Флаги
Источник сайта Изменить директорию, из которой Jekyll будет читать файлы	`source: DIR` `-s, --source DIR`
Путь назначения сайта Изменить директорию, в которую Jekyll будет записывать файлы	`destination: DIR` `-d, --destination DIR`
Безопасно Отключить плагины, не включенные в белый список, кэширование на диске и игнорировать символические ссылки.	`safe: BOOL` `--safe`
Отключить кэширование на диске 4.1.0 Отключить кэширование содержимого на диске, чтобы пропустить создание каталога `.jekyll-cache` или аналогичного каталога в источнике, чтобы избежать конфликтов с виртуальными окружениями и сторонними мониторами каталогов. Кэширование на диске всегда отключено в режиме `safe`.	`disable_disk_cache: BOOL` `--disable-disk-cache`
Игнорировать конфигурацию темы 4.1.0 Jekyll 4.0 начал разрешать темам объединять `_config.yml` для упрощения интеграции новых тем. В случае, если импорт конфигурации объединённой темы нарушает объединённую конфигурацию сайта, пользователь может настроить Jekyll так, чтобы он не импортировал конфигурацию темы полностью.	`ignore_theme_config: BOOL`
Исключить Исключить каталоги и/или файлы из преобразования. Эти исключения относительны к исходной директории сайта и не могут находиться за пределами этой директории.	`exclude: [DIR, FILE, ...]`
Включить Принудительно включить каталоги и/или файлы в преобразование. `.htaccess` — хороший пример, так как файлы с префиксом «.» исключаются по умолчанию.	`include: [DIR, FILE, ...]`
Сохранить файлы При перезаписи места назначения сайта, сохранить выбранные файлы. Полезно для файлов, которые не генерируются jekyll; например, файлы или активы, которые генерируются инструментом сборки. Пути относительны к `destination`.	`keep_files: [DIR, FILE, ...]`
Временная зона Установить временную зону для генерации сайта. Это устанавливает переменную среды `TZ`, которую Ruby использует для обработки создания и обработки времени и даты. Любой элемент из базы данных временных зон IANA допустим, например, `America/New_York`. Список всех доступных значений можно найти здесь. При работе на локальной машине временная зона по умолчанию устанавливается вашей операционной системой. Но при работе на удалённом хосте/сервере временная зона по умолчанию зависит от настроек или местоположения сервера.	`timezone: TIMEZONE`
Кодировка Установите кодировку файлов по имени (доступно только для Ruby 1.9 и новее). Значение по умолчанию — `utf-8` начиная с версии 2.0.0, и `nil` до версии 2.0.0, что приведет к значению по умолчанию Ruby — `ASCII-8BIT`. Доступные кодировки можно отобразить командой `ruby -e 'puts Encoding::list.join("\n")'`.	`encoding: ENCODING`
Значения по умолчанию Установите значения по умолчанию для переменных front matter.	см. ниже

Источник сайта

Изменить директорию, из которой Jekyll будет читать файлы

source: DIR

-s, --source DIR

Путь назначения сайта

Изменить директорию, в которую Jekyll будет записывать файлы

destination: DIR

-d, --destination DIR

Безопасно

Отключить плагины, не включенные в белый список, кэширование на диске и игнорировать символические ссылки.

safe: BOOL

--safe

Отключить кэширование на диске 4.1.0

Отключить кэширование содержимого на диске, чтобы пропустить создание каталога .jekyll-cache или аналогичного каталога в источнике, чтобы избежать конфликтов с виртуальными окружениями и сторонними мониторами каталогов. Кэширование на диске всегда отключено в режиме safe.

disable_disk_cache: BOOL

--disable-disk-cache

Игнорировать конфигурацию темы 4.1.0

Jekyll 4.0 начал разрешать темам объединять _config.yml для упрощения интеграции новых тем. В случае, если импорт конфигурации объединённой темы нарушает объединённую конфигурацию сайта, пользователь может настроить Jekyll так, чтобы он не импортировал конфигурацию темы полностью.

ignore_theme_config: BOOL

Исключить

Исключить каталоги и/или файлы из преобразования. Эти исключения относительны к исходной директории сайта и не могут находиться за пределами этой директории.

exclude: [DIR, FILE, ...]

Включить

Принудительно включить каталоги и/или файлы в преобразование. .htaccess — хороший пример, так как файлы с префиксом «.» исключаются по умолчанию.

include: [DIR, FILE, ...]

Сохранить файлы

При перезаписи места назначения сайта, сохранить выбранные файлы. Полезно для файлов, которые не генерируются jekyll; например, файлы или активы, которые генерируются инструментом сборки. Пути относительны к destination.

keep_files: [DIR, FILE, ...]

Временная зона

Установить временную зону для генерации сайта. Это устанавливает переменную среды TZ, которую Ruby использует для обработки создания и обработки времени и даты. Любой элемент из базы данных временных зон IANA допустим, например, America/New_York. Список всех доступных значений можно найти здесь. При работе на локальной машине временная зона по умолчанию устанавливается вашей операционной системой. Но при работе на удалённом хосте/сервере временная зона по умолчанию зависит от настроек или местоположения сервера.

timezone: TIMEZONE

Кодировка

Установите кодировку файлов по имени (доступно только для Ruby 1.9 и новее). Значение по умолчанию — utf-8 начиная с версии 2.0.0, и nil до версии 2.0.0, что приведет к значению по умолчанию Ruby — ASCII-8BIT. Доступные кодировки можно отобразить командой ruby -e 'puts Encoding::list.join("\n")'.

encoding: ENCODING

Значения по умолчанию

Установите значения по умолчанию для переменных front matter.

см. ниже

Папки назначения очищаются при создании сайта

Содержимое <destination> автоматически очищается при создании сайта по умолчанию. Файлы или папки, которые не создаются вашим сайтом, будут удалены. Некоторые файлы могут быть сохранены, указав их в директиве конфигурации <keep_files>.

Не используйте важное местоположение для <destination>; вместо этого используйте его как зону подготовки и копируйте файлы оттуда на ваш веб-сервер.

Параметры команды сборки

Настройка Параметры и Флаги

Настройка	Параметры и Флаги
Перегенерация Включить автоматическую перегенерацию сайта при изменении файлов.	`-w, --[no-]watch`
Конфигурация Указать файлы конфигурации вместо автоматического использования `_config.yml`. Настройки в более поздних файлах переопределяют настройки в более ранних файлах.	`--config FILE1[,FILE2,...]`
Плагины Указать директории плагинов вместо автоматического использования `_plugins/`.	`plugins_dir: [ DIR1,... ]` `-p, --plugins DIR1[,DIR2,...]`
Шаблоны Указать директорию шаблонов вместо автоматического использования `_layouts/`.	`layout_dir: DIR` `--layouts DIR`
Черновики Обработать и отобразить черновики постов.	`show_drafts: BOOL` `-D, --drafts`
Окружение Использовать определённое значение окружения при сборке.	`JEKYLL_ENV=production`
Будущее Опубликовать посты или документы коллекции с будущей датой.	`future: BOOL` `--future`
Неопубликованные Отобразить посты, помеченные как неопубликованные.	`unpublished: BOOL` `--unpublished`
LSI Создать индекс для связанных постов. Требует плагин classifier-reborn.	`lsi: BOOL` `--lsi`
Ограничить посты Ограничить количество постов для обработки и публикации.	`limit_posts: NUM` `--limit_posts NUM`
Принудительное опрошивание Принудительно заставить наблюдение использовать опрошивание.	`force_polling: BOOL` `--force_polling`
Подробный вывод Вывести подробный вывод.	`-V, --verbose`
Отключить вывод Отключить обычный вывод Jekyll во время сборки.	`-q, --quiet`
Инкрементная сборка Включить экспериментальную функцию инкрементной сборки. Инкрементная сборка перестраивает только изменённые посты и страницы, что значительно повышает производительность для больших сайтов, но в некоторых случаях может нарушить генерацию сайта.	`incremental: BOOL` `-I, --incremental`
Профилировщик Liquid Сгенерировать профиль рендеринга Liquid, чтобы помочь определить узкие места производительности.	`profile: BOOL` `--profile`
Строгий front matter Заставить сборку завершиться неудачей, если в front matter страницы есть ошибка синтаксиса YAML.	`strict_front_matter: BOOL` `--strict_front_matter`
Базовый URL Отображать веб-сайт с указанным базовым URL.	`baseurl: URL` `-b, --baseurl URL`
Отладочная информация Показать полный стек вызовов при возникновении ошибки.	`-t, --trace`

Перегенерация

Включить автоматическую перегенерацию сайта при изменении файлов.

-w, --[no-]watch

Конфигурация

Указать файлы конфигурации вместо автоматического использования _config.yml. Настройки в более поздних файлах переопределяют настройки в более ранних файлах.

--config FILE1[,FILE2,...]

Плагины

Указать директории плагинов вместо автоматического использования _plugins/.

plugins_dir: [ DIR1,... ]

-p, --plugins DIR1[,DIR2,...]

Шаблоны

Указать директорию шаблонов вместо автоматического использования _layouts/.

layout_dir: DIR

--layouts DIR

Черновики

Обработать и отобразить черновики постов.

show_drafts: BOOL

-D, --drafts

Окружение

Использовать определённое значение окружения при сборке.

JEKYLL_ENV=production

Будущее

Опубликовать посты или документы коллекции с будущей датой.

future: BOOL

--future

Неопубликованные

Отобразить посты, помеченные как неопубликованные.

unpublished: BOOL

--unpublished

LSI

Создать индекс для связанных постов. Требует плагин classifier-reborn.

lsi: BOOL

--lsi

Ограничить посты

Ограничить количество постов для обработки и публикации.

limit_posts: NUM

--limit_posts NUM

Принудительное опрошивание

Принудительно заставить наблюдение использовать опрошивание.

force_polling: BOOL

--force_polling

Подробный вывод

Вывести подробный вывод.

-V, --verbose

Отключить вывод

Отключить обычный вывод Jekyll во время сборки.

-q, --quiet

Инкрементная сборка

Включить экспериментальную функцию инкрементной сборки. Инкрементная сборка перестраивает только изменённые посты и страницы, что значительно повышает производительность для больших сайтов, но в некоторых случаях может нарушить генерацию сайта.

incremental: BOOL

-I, --incremental

Профилировщик Liquid

Сгенерировать профиль рендеринга Liquid, чтобы помочь определить узкие места производительности.

profile: BOOL

--profile

Строгий front matter

Заставить сборку завершиться неудачей, если в front matter страницы есть ошибка синтаксиса YAML.

strict_front_matter: BOOL

--strict_front_matter

Базовый URL

Отображать веб-сайт с указанным базовым URL.

baseurl: URL

-b, --baseurl URL

Отладочная информация

Показать полный стек вызовов при возникновении ошибки.

-t, --trace

Параметры команды запуска

В дополнение к параметрам ниже, подкоманда serve может принять любые параметры подкоманды build, которые затем применяются к сборке сайта, которая происходит непосредственно перед запуском вашего сайта.

Настройка Параметры и Флаги

Настройка	Параметры и Флаги
Порт локального сервера Прислушиваться к указанному порту.	`port: PORT` `-P, --port PORT`
Имя хоста локального сервера Прислушиваться к указанному имени хоста.	`host: HOSTNAME` `-H, --host HOSTNAME`
Автоперезагрузка Автоматически перезагружать страницу в браузере при редактировании её содержимого.	`livereload: BOOL` `-l, --livereload`
Игнорировать при автоперезагрузке Шаблоны glob-файлов для игнорирования LiveReload.	`livereload_ignore: [ GLOB1,... ]` `--livereload-ignore GLOB1[,GLOB2,...]`
Минимальная/максимальная задержка автоперезагрузки Минимальная/максимальная задержка перед автоматической перезагрузкой страницы.	`livereload_min_delay: SECONDS` `livereload_max_delay: SECONDS` `--livereload-min-delay SECONDS` `--livereload-max-delay SECONDS`
Порт автоперезагрузки Порт для прослушивания автоперезагрузки.	`--livereload-port PORT`
Открыть URL Открыть URL сайта в браузере.	`open_url: BOOL` `-o, --open-url`
Отсоединить Отсоединить сервер от терминала.	`detach: BOOL` `-B, --detach`
Пропустить первоначальную сборку сайта Пропустить первоначальную сборку сайта, которая происходит перед запуском сервера.	`skip_initial_build: BOOL` `--skip-initial-build`
Показать список каталога Показать список каталога вместо загрузки вашего файла index.	`show_dir_listing: BOOL` `--show-dir-listing`
Закрытый ключ X.509 (SSL) Закрытый ключ SSL, хранящийся или созданный как символическая ссылка в исходном коде сайта.	`--ssl-key`
Сертификат X.509 (SSL) Открытый сертификат SSL, хранящийся или созданный как символическая ссылка в исходном коде сайта.	`--ssl-cert`

Порт локального сервера

Прислушиваться к указанному порту.

port: PORT

-P, --port PORT

Имя хоста локального сервера

Прислушиваться к указанному имени хоста.

host: HOSTNAME

-H, --host HOSTNAME

Автоперезагрузка

Автоматически перезагружать страницу в браузере при редактировании её содержимого.

livereload: BOOL

-l, --livereload

Игнорировать при автоперезагрузке

Шаблоны glob-файлов для игнорирования LiveReload.

livereload_ignore: [ GLOB1,... ]

--livereload-ignore GLOB1[,GLOB2,...]

Минимальная/максимальная задержка автоперезагрузки

Минимальная/максимальная задержка перед автоматической перезагрузкой страницы.

livereload_min_delay: SECONDS
livereload_max_delay: SECONDS

--livereload-min-delay SECONDS
--livereload-max-delay SECONDS

Порт автоперезагрузки

Порт для прослушивания автоперезагрузки.

--livereload-port PORT

Открыть URL

Открыть URL сайта в браузере.

open_url: BOOL

-o, --open-url

Отсоединить

Отсоединить сервер от терминала.

detach: BOOL

-B, --detach

Пропустить первоначальную сборку сайта

Пропустить первоначальную сборку сайта, которая происходит перед запуском сервера.

skip_initial_build: BOOL

--skip-initial-build

Показать список каталога

Показать список каталога вместо загрузки вашего файла index.

show_dir_listing: BOOL

--show-dir-listing

Закрытый ключ X.509 (SSL)

Закрытый ключ SSL, хранящийся или созданный как символическая ссылка в исходном коде сайта.

--ssl-key

Сертификат X.509 (SSL)

Открытый сертификат SSL, хранящийся или созданный как символическая ссылка в исходном коде сайта.

--ssl-cert

Не используйте табуляцию в конфигурационных файлах

Это приведёт либо к ошибкам разбора, либо Jekyll вернётся к значениям по умолчанию. Используйте пробелы вместо табуляции.

© 2020 Jekyll Core Team and contributors
Licensed under the MIT license.
https://jekyllrb.com/docs/configuration/options/