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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

   $ cd PARENT-FOLDER

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

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

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

   $ cd REPOSITORY-NAME
   # Changes the working directory

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

   $ mkdir docs
   # Creates a new folder called docs
   $ cd docs

   Если вы решили опубликовать свой сайт из ветви gh-pages, создайте и проверьте ветвь gh-pages.

   $ 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

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

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

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

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

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

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

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

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

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

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

12. При необходимости внесите нужные изменения в файл _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
    

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

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

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

15. Добавьте репозиторий в GitHub.com в качестве удаленного репозитория, замена USER учетной записью, которая владеет репозиторием и REPOSITORY именем репозитория.

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

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

    $ git push -u origin BRANCH

17. Настройте источник публикации. Дополнительные сведения см. в разделе Настройка источника публикации для сайта GitHub Pages. 1. В GitHubперейдите в репозиторий сайта. 1. Под именем репозитория щелкните Параметры. Если вкладка "Параметры" не отображается, выберите раскрывающееся меню и выберите пункт Параметры.

    

18. В разделе «Код и автоматизация» на боковой панели щелкните Страницы .

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

    Примечание. Публикация изменений на сайте после передачи изменений в GitHub может занять до 10 минут. Если через час изменения сайта GitHub Pages не отображаются в браузере, см. раздел Сведения об ошибках сборки Jekyll для сайтов GitHub Pages.

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

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

Дальнейшие действия

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

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