Создание сайта GitHub Pages с помощью Jekyll

Вы можете использовать Jekyll, чтобы создать сайт GitHub Pages в новом или существующем репозитории.

Кто может использовать эту функцию?

People with admin permissions for a repository can create a GitHub Pages site with Jekyll.

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

Platform navigation

В этой статье

Примечание.

Хотя драгоценный github-pages камень остается поддерживаемым для некоторых рабочих процессов, GitHub Actions теперь является рекомендуемым подходом для развертывания и автоматизации сайтов GitHub Pages.

Необходимые компоненты

Прежде чем использовать Jekyll для создания сайта GitHub Pages, необходимо установить Jekyll и Git. Дополнительные сведения см. в документации по Jekyll и Настройка Git.

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

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

Совет

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

Создание репозитория для сайта

Для сайта можно создать новый репозиторий или выбрать существующий.

Если необходимо создать сайт GitHub Pages для репозитория, в котором не все файлы имеют отношение к сайту, можно настроить источник публикации. Например, можно использовать выделенную ветвь и папку для хранения исходных файлов сайта или использовать настраиваемый рабочий процесс GitHub Actions для создания и развертывания исходных файлов сайта.

Если учетная запись, которой принадлежит репозиторий, использует GitHub Free или GitHub Free для организаций, репозиторий должен быть общедоступным.

Если вы хотите создать сайт в существующем репозитории, перейдите к разделу "Создание сайта ".

  1. В правом верхнем углу любой страницы выберите , а затем нажмите кнопку "Создать репозиторий".

    Снимок экрана: раскрывающееся меню GitHub с параметрами создания новых элементов. Пункт меню "Новый репозиторий" описан в темно-оранжевый.

  2. Используйте раскрывающееся меню "Владелец"**, **чтобы выбрать учетную запись, которую вы хотите владеть репозиторием.

    Снимок экрана: меню владельца для нового репозитория GitHub. В меню показаны два параметра, октокат и github.

    Примечание.

    Если вы являетесь управляемая учетная запись пользователя, вы можете публиковать только сайты GitHub Pages из репозиториев, принадлежащих организациям. Дополнительные сведения см. в разделе Ограничения страниц GitHub.

  3. Введите имя репозитория и необязательное описание. Если вы создаете сайт пользователя или организации, репозиторию необходимо присвоить имя <user>.github.io или <organization>.github.io. Если имя пользователя или организации содержит прописные буквы, необходимо преобразовать их в нижний регистр. Дополнительные сведения см. в разделе Что такое GitHub Pages?.

    Снимок экрана: параметры GitHub Pages в репозитории. Поле имени репозитория содержит текст "octocat.github.io" и описывается темно-оранжевым цветом.

  4. Настройте видимость репозитория. Дополнительные сведения см. в разделе Сведения о репозиториях.

Создание сайта

Прежде чем создать сайт, необходимо иметь репозиторий для сайта на GitHub. Если вы не создаете сайт в существующем репозитории, см. статью "Создание репозитория для сайта".

Предупреждение

, если ваше предприятие не использует Enterprise Managed Users, GitHub Pages сайты по умолчанию доступны в Интернете, даже если репозиторий для сайта является частным или внутренним. Для публикации сайта с закрытым доступом используйте управление доступом. Либо, если в репозитории вашего сайта есть конфиденциальные данные, удалите их перед публикацией. Дополнительные сведения см. в разделе [AUTOTITLE и Сведения о репозиториях](/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site).

  1. Откройте ТерминалТерминалGIT Bash.

  2. Если у вас еще нет локальной копии репозитория, перейдите к расположению, где вы хотите хранить исходные файлы сайта, заменив PARENT-FOLDER папкой, в которой должна содержаться папка для репозитория.

    cd PARENT-FOLDER

  3. Если это еще не сделано, инициализируйте локальный репозиторий Git, заменив REPOSITORY-NAME именем вашего репозитория.

    git init REPOSITORY-NAME
> Initialized empty Git repository in /REPOSITORY-NAME/.git/
# Creates a new folder on your computer, initialized as a Git repository

  4. Измените каталоги на репозиторий.

    cd REPOSITORY-NAME
# Changes the working directory

  5. Укажите, какой источник публикации вы хотите использовать. Дополнительные сведения см. в разделе Настройка источника публикации для вашего сайта GitHub Pages.

  6. Перейдите к источнику публикации для сайта. Дополнительные сведения см. в разделе Настройка источника публикации для вашего сайта GitHub Pages. Например, если вы решили опубликовать свой сайт из папки docs в ветви по умолчанию, создайте и измените каталоги на папку docs.

    mkdir docs
# Creates a new folder called docs
cd docs

    If you chose to publish your site from the gh-pages branch, create and checkout the gh-pages branch.

    git checkout --orphan gh-pages
# Creates a new branch, with no history or contents, called gh-pages, and switches to the gh-pages branch
git rm -rf .
# Removes the contents from your default branch from the working directory

  7. Чтобы создать новый сайт Jekyll, используйте jekyll new команду в корневом каталоге репозитория:

    jekyll new --skip-bundle .
# Creates a Jekyll site in the current directory

  8. Откройте файл Gemfile, созданный Jekyll.

  9. Добавьте "#" в начало строки, которая начинается с gem "jekyll", чтобы закомментировать эту строку.

  10. Добавьте зависимость github-pages, изменив строку, начинающуюся с # gem "github-pages". Измените эту строку следующим образом:

    gem "github-pages", "~> GITHUB-PAGES-VERSION", group: :jekyll_plugins

    Замените GITHUB-PAGES-VERSION последней поддерживаемой версией драгоценных камней github-pages . Эту версию можно найти здесь: версии зависимостей.

    Правильная версия Jekyll будет установлена в качестве зависимости gem github-pages.

  11. Сохраните и закройте Gemfile.

  12. Выполните из командной строки команду bundle install.

  13.        `.gitignore` Откройте файл, созданный Jekyll, и игнорируйте файл блокировки драгоценных камней, добавив следующую строку:

    Gemfile.lock

  14. При необходимости внесите нужные изменения в файл _config.yml. Это требуется для относительных путей, когда репозиторий размещается в подкаталоге. Дополнительные сведения см. в разделе Разделение подпапки в новый репозиторий.

    domain: my-site.github.io       # if you want to force HTTPS, specify the domain without the http at the start, e.g. example.com
url: https://my-site.github.io  # the base hostname and protocol for your site, e.g. http://example.com
baseurl: /REPOSITORY-NAME/      # place folder name if the site is served in a subfolder

  15. При желании протестируйте сайт локально. Дополнительные сведения см. в статье "Тестирование сайта GitHub Pages локально с помощью Jekyll.

  16. Добавьте и зафиксируйте свою работу.

    git add .
git commit -m 'Initial GitHub pages site with Jekyll'

  17. Добавьте репозиторий в GitHub.com в качестве удаленного, заменив USER учетной записью, которая владеет репозиторием и РЕПОЗИТОРИй с именем репозитория.

    
git remote add origin https://github.com/USER/REPOSITORY.git

  18. Отправьте репозиторий в GitHub, заменив BRANCH именем ветви, над которыми вы работаете.

    git push -u origin BRANCH

  19. Настройте источник публикации. Дополнительные сведения см. в разделе Настройка источника публикации для вашего сайта GitHub Pages.

  20. На сайте GitHubперейдите в репозиторий сайта.

  21. Под именем репозитория щелкните Settings. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и нажмите кнопку "Параметры".

    Снимок экрана: заголовок репозитория с вкладками. Вкладка "Параметры" выделена темно-оранжевым контуром.

  22. В разделе "Код и автоматизация" боковой панели щелкните Pages.

  23. При необходимости, если вы публикуете сайт проекта из частного или внутреннего репозитория, выберите видимость для вашего сайта. В разделе "GitHub Pages" выберите раскрывающееся меню видимости, а затем выберите общедоступный или закрытый.

    Снимок экрана: параметры Pages для репозитория. Раскрывающийся список видимости, который в настоящее время имеет значение Private, описывается в темно-оранжевый цвет.

    Примечание.

    Чтобы опубликовать сайт GitHub Pages в частном порядке, ваша организация должна использовать GitHub Enterprise Cloud. Дополнительные сведения о том, как использовать GitHub Enterprise Cloud бесплатно, см. в статье "Настройка пробной версии GitHub Enterprise Cloud".

  24. Чтобы просмотреть опубликованный сайт, в разделе "GitHub Pages" щелкните Посетите сайт.

    Снимок экрана: сообщение подтверждения для GitHub Pages с указанием URL-адреса сайта. Серая кнопка "Посетите сайт" выделена оранжевым цветом.

    Примечание.

    Изменение сайта может занять до 10 минут после отправки изменений в GitHub. Если вы не видите изменения сайта GitHub Pages, отраженные в браузере через час, см . раздел AUTOTITLE.

  25. Ваш сайт GitHub Pages создан и развернут с помощью рабочего процесса GitHub Actions. Дополнительные сведения см. в разделе Просмотр журнала выполнения рабочего процесса.

    Примечание.

    GitHub Actions предоставляется бесплатно для общедоступных репозиториев. Плата за использование начисляется для частных и внутренних репозиториев, которые превышают число выделяемых ежемесячно бесплатных минут. Дополнительные сведения см. в разделе Выставление счетов и использование.

Примечание.

  • Если вы публикуете из ветви и сайт не публикуется автоматически, убедитесь, что кто-то с разрешениями администратора и проверенный адрес электронной почты отправлен в источник публикации.
  • Фиксации, отправленные рабочим процессом GitHub Actions с использованием GITHUB_TOKEN сборки GitHub Pages.

Следующие шаги

Чтобы добавить новую страницу или публикацию на сайт, см. раздел Добавление контента на ваш сайт GitHub Pages с помощью Jekyll.

Вы можете добавить тему Jekyll на сайт GitHub Pages, чтобы настроить его внешний вид. Дополнительные сведения см. в разделе Добавление темы на ваш сайт GitHub Pages с помощью Jekyll.