Тестировать сайт GitHub Pages локально может любой пользователь с разрешениями на чтение для репозитория.
Необходимые компоненты
Прежде чем тестировать сайт с помощью Jekyll, необходимо выполнить следующие действия:
- Установить Jekyll.
- Создать сайт Jekyll. Дополнительные сведения см. в разделе Создание сайта GitHub Pages с помощью Jekyll.
Мы рекомендуем использовать Средство увязки программ в пакеты для установки и запуска Jekyll. Средство увязки программ в пакеты управляет зависимостями Ruby, уменьшает ошибки сборки Jekyll и предотвращает ошибки, связанные со средой. Чтобы установить Средство увязки программ в пакеты, выполните следующие действия.
- Установите Ruby. Дополнительные сведения см. в разделе Установка Ruby документации по Ruby.
- Установка Средства увязки программ в пакеты. Дополнительную информацию см. в разделе Средство увязки программ в пакеты.
Совет. Если при попытке установить Jekyll с помощью Средства связывания программ в пакеты возникает ошибка Ruby, может потребоваться использовать диспетчер пакетов, например RVM или Homebrew для управления установкой Ruby. Дополнительные сведения см. в статье Устранение неполадок в документации по Jekyll.
Локальное создание сайта
-
Откройте ТерминалТерминалGIT Bash.
-
Перейдите к источнику публикации для сайта. Дополнительные сведения см. в разделе Настройка источника публикации для сайта GitHub Pages.
-
Запустите
bundle install
. -
Запустите сайт Jekyll локально.
$ bundle exec jekyll serve > Configuration file: /Users/octocat/my-site/_config.yml > Source: /Users/octocat/my-site > Destination: /Users/octocat/my-site/_site > Incremental build: disabled. Enable with --incremental > Generating... > done in 0.309 seconds. > Auto-regeneration: enabled for '/Users/octocat/my-site' > Configuration file: /Users/octocat/my-site/_config.yml > Server address: http://127.0.0.1:4000/ > Server running... press ctrl-c to stop.
Примечания:
-
Если вы установили Ruby 3.0 или более поздней версии (если вы установили версию по умолчанию через Homebrew), на этом шаге может возникнуть ошибка. Это связано с тем, что эти версии Ruby больше не установлены
webrick
.Чтобы устранить ошибку, попробуйте выполнить
bundle add webrick
, а затем повторно запуститьbundle exec jekyll serve
. -
_config.yml
Если поле файлаbaseurl
содержит ссылку репозитория GitHub, вы можете использовать следующую команду при локальном создании, чтобы игнорировать это значение и обслуживать сайт наlocalhost:4000/
:bundle exec jekyll serve --baseurl=""
-
-
Чтобы выполнить предварительный просмотр сайта в веб-браузере, перейдите по адресу
http://localhost:4000
.
Обновление пакета GitHub Pages
Jekyll — это активный проект с открытым кодом, который регулярно обновляется. Если версия пакета github-pages
на компьютере устарела относительно версии пакета github-pages
на сервере GitHub Pages, создаваемый локально сайт может выглядеть не так, как при публикации в GitHub Enterprise Server. Чтобы избежать этого, регулярно обновляйте пакет github-pages
на компьютере.
- Откройте ТерминалТерминалGIT Bash.
- Обновите пакет
github-pages
.- Если установлено средство увязки, выполните команду
bundle update github-pages
. - Если средство увязки не установлено, выполните команду
gem update github-pages
.
- Если установлено средство увязки, выполните команду
Дополнительные материалы
- GitHub Pages в документации по Jekyll