Skip to main content

Добавление темы на ваш сайт GitHub Pages с помощью Jekyll

Вы можете персонализировать свой сайт Jekyll, добавив и настроив тему оформления.

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

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

Примечание.

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

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

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

Поддерживаемые темы

Из поля поддерживаются следующие темы:

Подключаемый jekyll-remote-theme модуль Jekyll также доступен и позволяет загружать другие темы.

Добавление темы

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

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

  3. Перейдите по адресу _config.yml.

  4. В правом верхнем углу представления файла щелкните (Изменить файл), чтобы открыть редактор файлов.

    Снимок экрана: файл. В заголовке кнопка, помеченная значком карандаша, описывается темно-оранжевым цветом.

    Примечание.

    Вместо редактирования и фиксации файла с помощью редактора файлов по умолчанию можно при необходимости использовать редактор кода github.dev, выбрав раскрывающееся меню и щелкнув github.dev. Вы также можете клонировать репозиторий и изменить файл локально с помощью GitHub Desktop, щелкнув GitHub Desktop.

    Снимок экрана: файл. В верхнем колонтитуле значок треугольника с лицом вниз очертается темно-оранжевым цветом.

  5. Добавьте в файл новую строку для имени темы.

    • Чтобы использовать поддерживаемую тему, введите theme: THEME-NAME, заменив THEME-NAME именем темы, как показано в _config.yml репозитории темы (большинство тем соответствуют jekyll-theme-NAME соглашению об именовании). Список поддерживаемых тем см. на сайте GitHub Pages. Например, чтобы выбрать минимальную тему, введите theme: jekyll-theme-minimal.
    • Чтобы использовать любую другую тему Jekyll, размещенную на GitHub, введите remote_theme: THEME-NAME, заменив THEME-NAME именем темы, как показано в файле README репозитория темы.
  6. Нажмите кнопку " Зафиксировать изменения" ...

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

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

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

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

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

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

Настройка CSS-темы

Эти инструкции лучше всего подходят для тем, которые официально поддерживаются GitHub Pages. Полный список поддерживаемых тем см. на сайте GitHub Pages.

Исходный репозиторий темы может помочь в настройке темы. Например, см . раздел README минимального размера.

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

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

  3. Создайте файл с именем /assets/css/style.scss.

  4. Добавьте следующее содержимое в верхнюю часть файла:

    ---
    ---
    
    @import "{{ site.theme }}";
    
  5. Добавьте любые пользовательские CSS или Sass (включая импорты) сразу после строки @import.

Настройка макета HTML-темы

Эти инструкции лучше всего подходят для тем, которые официально поддерживаются GitHub Pages. Полный список поддерживаемых тем см. на сайте GitHub Pages.

Исходный репозиторий темы может помочь в настройке темы. Например, см . раздел README минимального размера.

  1. Перейдите к исходному репозиторию вашей темы в GitHub. Например, исходный репозиторий для Минимального https://github.com/pages-themes/minimal.
  2. В папке перейдите к файлу _layouts темы _default.html .
  3. Скопируйте содержимое файла.
  4. На сайте GitHubперейдите в репозиторий сайта.
  5. Перейдите к источнику публикации для сайта. Дополнительные сведения см. в разделе Настройка источника публикации для вашего сайта GitHub Pages.
  6. Создайте файл с именем _layouts/default.html.
  7. Вставьте скопированное ранее содержимое макета по умолчанию.
  8. Настройте макет как вам нужно.

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