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

В таблицах ниже перечислены доступные настройки 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`
Исключить Исключить каталоги и/или файлы из преобразования. Эти исключения задаются относительно исходного каталога сайта и не могут находиться за его пределами. Этот параметр конфигурации поддерживает шаблоны Ruby для поиска файлов по маске `File.fnmatch`, позволяющие выбрать несколько записей для исключения. Например, чтобы не включать в сайт несколько файлов README.md из дерева исходных файлов, укажите следующие записи параметра `exclude`: `["README.md", "**/README.md"]`. В Jekyll 3 параметр конфигурации `exclude` заменяет список исключений по умолчанию. В Jekyll 4 записи, указанные пользователем, добавляются к списку исключений по умолчанию, а параметр `include` позволяет переопределить записи этого списка. Исключения по умолчанию указаны в `_config.yml`, созданном с помощью `jekyll new`: `.sass-cache/` `.jekyll-cache/` `gemfiles/` `Gemfile` `Gemfile.lock` `node_modules/` `vendor/bundle/` `vendor/cache/` `vendor/gems/` `vendor/ruby/`	`exclude: [DIR, FILE, ...]`
Включить Принудительно включить каталоги и/или файлы в преобразование. `.htaccess` — хороший пример, поскольку файлы, имена которых начинаются с точки, по умолчанию исключаются. Этот параметр конфигурации поддерживает шаблоны Ruby для поиска файлов по маске `File.fnmatch`, позволяющие выбрать несколько записей для включения. Дополнительную информацию см. в параметре конфигурации `exclude`. В Jekyll 4 записи параметра конфигурации `include` переопределяют записи параметра `exclude`.	`include: [DIR, FILE, ...]`
Сохранить файлы При очистке каталога назначения сайта сохранить выбранные файлы. Полезно для файлов, созданных не Jekyll, например файлов или ресурсов, созданных вашим инструментом сборки. Пути указываются относительно `destination`.	`keep_files: [DIR, FILE, ...]`
Часовой пояс Задать часовой пояс для генерации сайта. При этом задаётся переменная окружения `TZ`, которую Ruby использует для обработки времени и создания и изменения дат. Допускается любое значение из базы часовых поясов IANA, например `America/New_York`. Здесь можно найти список всех доступных значений. При запуске на локальном компьютере часовой пояс по умолчанию определяется операционной системой. При запуске на удалённом хосте/сервере часовой пояс по умолчанию зависит от настроек или местоположения сервера.	`timezone: TIMEZONE`
Кодировка Задать кодировку файлов по имени (доступно только в Ruby 1.9 и более поздних версиях). Начиная с версии 2.0.0 значение по умолчанию — `utf-8`, а в версиях до 2.0.0 — `nil`; в результате используется значение по умолчанию для Ruby — `ASCII-8BIT`. Список доступных кодировок можно вывести командой `ruby -e 'puts Encoding::list.join("\n")'`.	`encoding: ENCODING`
Значения по умолчанию Задать значения по умолчанию для переменных предварительных данных.	см. ниже

Исходная директория сайта

Изменить каталог, из которого 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

Исключить

Исключить каталоги и/или файлы из преобразования. Эти исключения задаются относительно исходного каталога сайта и не могут находиться за его пределами.
Этот параметр конфигурации поддерживает шаблоны Ruby для поиска файлов по маске File.fnmatch, позволяющие выбрать несколько записей для исключения. Например, чтобы не включать в сайт несколько файлов README.md из дерева исходных файлов, укажите следующие записи параметра exclude: ["README.md", "**/README.md"].
В Jekyll 3 параметр конфигурации exclude заменяет список исключений по умолчанию.
В Jekyll 4 записи, указанные пользователем, добавляются к списку исключений по умолчанию, а параметр include позволяет переопределить записи этого списка.
Исключения по умолчанию указаны в _config.yml, созданном с помощью jekyll new:

.sass-cache/
.jekyll-cache/
gemfiles/
Gemfile
Gemfile.lock
node_modules/
vendor/bundle/
vendor/cache/
vendor/gems/
vendor/ruby/

exclude: [DIR, FILE, ...]

Включить

Принудительно включить каталоги и/или файлы в преобразование. .htaccess — хороший пример, поскольку файлы, имена которых начинаются с точки, по умолчанию исключаются.
Этот параметр конфигурации поддерживает шаблоны Ruby для поиска файлов по маске File.fnmatch, позволяющие выбрать несколько записей для включения. Дополнительную информацию см. в параметре конфигурации exclude.
В Jekyll 4 записи параметра конфигурации include переопределяют записи параметра exclude.

include: [DIR, FILE, ...]

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

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

keep_files: [DIR, FILE, ...]

Часовой пояс

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

timezone: TIMEZONE

Кодировка

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

encoding: ENCODING

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

Задать значения по умолчанию для переменных предварительных данных.

см. ниже

Каталоги назначения очищаются при сборке сайта

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

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

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

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

Настройка	Параметры и флаги
Перегенерация Включить автоматическую перегенерацию сайта при изменении файлов.	`-w, --[no-]watch`
Конфигурация Указать файлы конфигурации вместо автоматического использования `_config.yml`. Настройки в более поздних файлах переопределяют настройки из предыдущих файлов.	`--config FILE1[,FILE2,...]`
Плагины Указать каталоги плагинов вместо автоматического использования `_plugins/`.	`plugins_dir: [ DIR1,... ]` `-p, --plugins DIR1[,DIR2,...]`
Макеты Указать каталог макетов вместо автоматического использования `_layouts/`.	`layouts_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`
Подробный вывод Выводить подробную информацию.	`verbose: BOOL` `-V, --verbose`
Отключить вывод Отключить обычный вывод Jekyll во время сборки.	`quiet: BOOL` `-q, --quiet`
Уровень журнала Указать уровень ведения журнала: debug, info, warn или error.	`JEKYLL_LOG_LEVEL=info`
Инкрементальная сборка Включить экспериментальную функцию инкрементальной сборки. При инкрементальной сборке повторно собираются только изменённые записи и страницы, что значительно повышает производительность крупных сайтов, но в некоторых случаях может нарушить генерацию сайта.	`incremental: BOOL` `-I, --incremental`
Отключить загрузку зависимостей из bundle Отключает необходимость подключать гемы из Gemfile через `:jekyll_plugins`	`JEKYLL_NO_BUNDLER_REQUIRE=true`
Профилировщик Liquid Создать профиль рендеринга Liquid, чтобы помочь выявить узкие места производительности.	`profile: BOOL` `--profile`
Строгая проверка предварительных данных Завершать сборку с ошибкой, если в предварительных данных страницы обнаружена синтаксическая ошибка YAML.	`strict_front_matter: BOOL` `--strict_front_matter`
URL веб-сайта Канонический URL корневого каталога опубликованного сайта, состоящий из следующих компонентов: • Схема протокола (например, `http://`) • Имя хоста или IP-адрес (например, `example.org`) • (Необязательно) Номер порта сервера с двоеточием перед ним (например, `:8080`) Значение этого параметра конфигурации НЕ должно заканчиваться косой чертой. При использовании фильтра Liquid `absolute_url` к нему добавляется `baseurl`, чтобы сформировать полный URL вашего сайта на Jekyll. ПРИМЕЧАНИЕ: При вызове команды `jekyll serve` для этого параметра автоматически задаётся URL localhost.	`url: SCHEME://HOST[:PORT]`
Базовый URL Разместить сайт по указанному базовому URL (путь между корнем веб-сервера или домена и главной страницей).	`baseurl: /PATH/TO/SITE` `-b, --baseurl /PATH/TO/SITE`
Трассировка Показывать полную трассировку стека при возникновении ошибки.	`-t, --trace`

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

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

-w, --[no-]watch

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

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

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

Плагины

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

plugins_dir: [ DIR1,... ]

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

Макеты

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

layouts_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

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

Выводить подробную информацию.

verbose: BOOL

-V, --verbose

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

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

quiet: BOOL

-q, --quiet

Уровень журнала

Указать уровень ведения журнала: debug, info, warn или error.

JEKYLL_LOG_LEVEL=info

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

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

incremental: BOOL

-I, --incremental

Отключить загрузку зависимостей из bundle

Отключает необходимость подключать гемы из Gemfile через `:jekyll_plugins`

JEKYLL_NO_BUNDLER_REQUIRE=true

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

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

profile: BOOL

--profile

Строгая проверка предварительных данных

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

strict_front_matter: BOOL

--strict_front_matter

URL веб-сайта

Канонический URL корневого каталога опубликованного сайта, состоящий из следующих компонентов:
• Схема протокола (например, http://)
• Имя хоста или IP-адрес (например, example.org)
• (Необязательно) Номер порта сервера с двоеточием перед ним (например, :8080)
Значение этого параметра конфигурации НЕ должно заканчиваться косой чертой. При использовании фильтра Liquid absolute_url к нему добавляется baseurl, чтобы сформировать полный URL вашего сайта на Jekyll.
ПРИМЕЧАНИЕ: При вызове команды jekyll serve для этого параметра автоматически задаётся URL localhost.

url: SCHEME://HOST[:PORT]

Базовый URL

Разместить сайт по указанному базовому URL (путь между корнем веб-сервера или домена и главной страницей).

baseurl: /PATH/TO/SITE

-b, --baseurl /PATH/TO/SITE

Трассировка

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

-t, --trace

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

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

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

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

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

Прослушивать указанный порт. По умолчанию используется `4000`.

port: PORT

-P, --port PORT

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

Прослушивать указанный хост. По умолчанию используется `localhost`.

host: HOSTNAME

-H, --host HOSTNAME

Автоматическая перезагрузка

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

livereload: BOOL

-l, --livereload

Исключения для автоматической перезагрузки

Шаблоны файловых масок, которые LiveReload должен игнорировать.

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

Примечание: Указанные шаблоны сопоставляются со свойством relative_path обработанного ресурса. Если Jekyll перезагружает relative_path, соответствующий шаблону, несмотря на кавычки, попробуйте указать шаблон(ы) в параметре конфигурации.

livereload_ignore: [ GLOB1,... ]

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

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

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

livereload_min_delay: SECONDS
livereload_max_delay: SECONDS

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

Порт автоматической перезагрузки

Порт, который будет прослушивать LiveReload.
Возможность переопределения через файл конфигурации появилась в версии 4.4.0.

livereload_port: PORT

--livereload-port PORT

Открыть URL

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

open_url: BOOL

-o, --open-url

Запуск в отдельном процессе

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

detach: BOOL

-B, --detach

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

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

skip_initial_build: BOOL

--skip-initial-build

Показывать список файлов каталога

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

show_dir_listing: BOOL

--show-dir-listing

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

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

--ssl-key

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

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

--ssl-cert

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

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

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