Добавление содержимого на сайт GitHub Pages с помощью Jekyll

Можно добавить новую страницу или сделать публикацию на сайте Jekyll в GitHub Pages.

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

GitHub Pages is available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s plans.

GitHub Pages now uses GitHub Actions to execute the Jekyll build. When using a branch as the source of your build, GitHub Actions must be enabled in your repository if you want to use the built-in Jekyll workflow. Alternatively, if GitHub Actions is unavailable or disabled, adding a .nojekyll file to the root of your source branch will bypass the Jekyll build process and deploy the content directly. For more information on enabling GitHub Actions, see Managing GitHub Actions settings for a repository.

В этой статье

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

О содержимом на сайтах Jekyll

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

Основными типами содержимого для сайтов Jekyll являются страницы и записи. Страница предназначена для автономного содержимого, которое не связано с определенной датой, как, например, страница "Сведения". Сайт Jekyll по умолчанию содержит файл с именем about.md, который отображается как страница на вашем сайте в YOUR-SITE-URL/about. Вы можете изменять содержимое этого файла, чтобы персонализировать страницу "Сведения", а также использовать страницу "Сведения" в качестве шаблона для создания новых страниц. Дополнительные сведения см. в разделе Pages в документации Jekyll.

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

Тема включает макеты по умолчанию, включаемые объекты и таблицы стилей, которые будут автоматически применяться к новым страницам и записям на сайте, но вы можете переопределить любой из этих стандартных объектов. Дополнительные сведения см. в разделе Сведения о GitHub Pages и Jekyll.

Чтобы задать переменные и метаданные, такие как название и макет, для страницы или публикации на сайте, можно добавить титульный лист YAML в начало любого файла Markdown или HTML. Дополнительные сведения см. в документации Jekyll.

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

Добавление на сайт новой страницы

  1. В GitHubперейдите в репозиторий сайта.

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

  3. В корневом каталоге источника публикации создайте новый файл для страницы PAGE-NAME.md, заменив PAGE-NAME значимым именем файла для страницы.

  4. Добавьте следующий интерфейс YAML в начало файла, заменив PAGE-TITLE заголовком страницы и URL-ПУТЬ на путь к URL-адресу страницы. Например, если базовый URL-адрес вашего сайта и https://octocat.github.io URL-ПУТЬ— /about/contact/это, ваша страница будет находиться по адресу https://octocat.github.io/about/contact.

    layout: page
title: "PAGE-TITLE"
permalink: /URL-PATH

  5. Под заглавным блоком добавьте содержимое для страницы.

  6. Нажмите кнопку " Зафиксировать изменения...

  7. В поле "Фиксация сообщения" введите короткое понятное сообщение фиксации, описывающее изменения, внесенные в файл. В таком сообщении фиксацию можно отнести к нескольким авторам. Дополнительные сведения см. в разделе Создание фиксации с несколькими авторами.

  8. Если у вас несколько адресов электронной почты, связанных с учетной записью в GitHub, щелкните раскрывающееся меню адреса электронной почты и выберите адрес электронной почты, используемый в качестве адреса электронной почты автора Git. В этом раскрывающемся меню отображаются только проверенные адреса электронной почты. Если вы включили конфиденциальность адресов электронной почты, то ответ не будет по умолчанию автор фиксации адреса электронной почты. Дополнительные сведения о точной форме, которую может принимать адрес электронной почты без ответа, см. в разделе Указание адреса электронной почты для фиксаций.

    Снимок экрана: запрос на извлечение GitHub с раскрывающимся меню с параметрами выбора адреса электронной почты автор фиксации. octocat@github.com выбран.

  9. Под полями сообщения о фиксации укажите, куда следует добавить фиксацию: в текущую ветвь или в новую. Если текущей ветвью является ветвь по умолчанию, нужно создать новую ветвь для фиксации, а затем создать запрос на вытягивание. Дополнительные сведения см. в разделе Создание запроса на включение изменений.

    Снимок экрана: запрос на вытягивание GitHub с переключателем для фиксации непосредственно в главной ветви или создания новой ветви. Выбрана новая ветвь.

  10. Нажмите кнопку Зафиксировать изменения или Предложить изменения.

  11. Создайте запрос на вытягивание для предлагаемых изменений.

  12. В списке "Запросы на вытягивание" щелкните запрос на вытягивание, который хотите объединить.

  13. Щелкните Выполнить слияние запросов на вытягивание. Дополнительные сведения см. в разделе Слияние запроса на вытягивание.

  14. При появлении запроса введите сообщение о фиксации или примите сообщение по умолчанию.

  15. Щелкните Подтвердить слияние.

  16. При необходимости удалите ветвь. Дополнительные сведения см. в разделе Создание и удаление ветвей в репозитории.

Добавление на сайт новой записи

  1. В GitHubперейдите в репозиторий сайта.

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

  3. Перейдите к каталогу _posts.

  4. Создайте новый файл с именем YYYY-MM-DD-NAME-OF-POST.md, заменив ггГГ-ММ-ДД датой публикации и ИМЕНИ-POST именем вашей записи.

  5. Добавьте следующий интерфейс YAML в верхнюю часть файла, включая название публикации, заключенное в кавычки, дату и время записи в формате ГГГГ-ММ-ДД чч:мм:сс -0000 и столько категорий, сколько нужно для публикации.

    layout: post
title: "POST-TITLE"
date: YYYY-MM-DD hh:mm:ss -0000
categories: CATEGORY-1 CATEGORY-2

  6. Под заглавным блоком добавьте содержимое для записи.

  7. Нажмите кнопку " Зафиксировать изменения...

  8. В поле "Фиксация сообщения" введите короткое понятное сообщение фиксации, описывающее изменения, внесенные в файл. В таком сообщении фиксацию можно отнести к нескольким авторам. Дополнительные сведения см. в разделе Создание фиксации с несколькими авторами.

  9. Если у вас несколько адресов электронной почты, связанных с учетной записью в GitHub, щелкните раскрывающееся меню адреса электронной почты и выберите адрес электронной почты, используемый в качестве адреса электронной почты автора Git. В этом раскрывающемся меню отображаются только проверенные адреса электронной почты. Если вы включили конфиденциальность адресов электронной почты, то ответ не будет по умолчанию автор фиксации адреса электронной почты. Дополнительные сведения о точной форме, которую может принимать адрес электронной почты без ответа, см. в разделе Указание адреса электронной почты для фиксаций.

    Снимок экрана: запрос на извлечение GitHub с раскрывающимся меню с параметрами выбора адреса электронной почты автор фиксации. octocat@github.com выбран.

  10. Под полями сообщения о фиксации укажите, куда следует добавить фиксацию: в текущую ветвь или в новую. Если текущей ветвью является ветвь по умолчанию, нужно создать новую ветвь для фиксации, а затем создать запрос на вытягивание. Дополнительные сведения см. в разделе Создание запроса на включение изменений.

    Снимок экрана: запрос на вытягивание GitHub с переключателем для фиксации непосредственно в главной ветви или создания новой ветви. Выбрана новая ветвь.

  11. Нажмите кнопку Зафиксировать изменения или Предложить изменения.

  12. Создайте запрос на вытягивание для предлагаемых изменений.

  13. В списке "Запросы на вытягивание" щелкните запрос на вытягивание, который хотите объединить.

  14. Щелкните Выполнить слияние запросов на вытягивание. Дополнительные сведения см. в разделе Слияние запроса на вытягивание.

  15. При появлении запроса введите сообщение о фиксации или примите сообщение по умолчанию.

  16. Щелкните Подтвердить слияние.

  17. При необходимости удалите ветвь. Дополнительные сведения см. в разделе Создание и удаление ветвей в репозитории.

Теперь ваша запись должна появиться на вашем сайте! Если базовый URL-адрес вашего сайта — https://octocat.github.io, новая публикация будет размещена по адресу https://octocat.github.io/YYYY/MM/DD/TITLE.html.

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

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