Skip to main content

Локальное тестирование сайта GitHub Pages с помощью Jekyll

Вы можете создать сайт GitHub Pages локально для предварительного просмотра и тестирования изменений сайта.

GitHub Pages доступен в общедоступных репозиториях при использовании GitHub Free и GitHub Free для организаций, а также в общедоступных и частных репозиториях при использовании GitHub Pro, GitHub Team, GitHub Enterprise Cloud и GitHub Enterprise Server. Дополнительные сведения см. в разделе Продукты GitHub.

Тестировать сайт GitHub Pages локально может любой пользователь с разрешениями на чтение для репозитория.

Предварительные требования

Прежде чем тестировать сайт с помощью Jekyll, необходимо выполнить следующие действия:

Мы рекомендуем использовать Средство увязки программ в пакеты для установки и запуска Jekyll. Средство увязки программ в пакеты управляет зависимостями Ruby, уменьшает ошибки сборки Jekyll и предотвращает ошибки, связанные со средой. Чтобы установить Средство увязки программ в пакеты, выполните следующие действия.

  1. Установите Ruby. Дополнительные сведения см. в разделе Установка Ruby документации по Ruby.
  2. Установка Средства увязки программ в пакеты. Дополнительную информацию см. в разделе Средство увязки программ в пакеты.

Совет. Если при попытке установить Jekyll с помощью Средства связывания программ в пакеты возникает ошибка Ruby, может потребоваться использовать диспетчер пакетов, например RVM или Homebrew для управления установкой Ruby. Дополнительные сведения см. в статье Устранение неполадок в документации по Jekyll.

Локальное создание сайта

  1. Откройте ТерминалТерминалGIT Bash. 1. Перейдите к источнику публикации для сайта. Дополнительные сведения см. в статье "Настройка источника публикации для сайта GitHub Pages".

  2. Выполните команду bundle install.

  3. Запустите сайт 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.

  4. Чтобы выполнить предварительный просмотр сайта в веб-браузере, перейдите по адресу http://localhost:4000.

Обновление пакета GitHub Pages

Jekyll — это активный проект с открытым кодом, который регулярно обновляется. Если версия пакета github-pages на компьютере устарела относительно версии пакета github-pages на сервере GitHub Pages, создаваемый локально сайт может выглядеть не так, как при публикации в GitHub. Чтобы избежать этого, регулярно обновляйте пакет github-pages на компьютере.

  1. Откройте ТерминалТерминалGIT Bash.
  2. Обновите пакет github-pages.
    • Если установлено средство увязки, выполните команду bundle update github-pages.
    • Если средство увязки не установлено, выполните команду gem update github-pages.

Дополнительные материалы