Быстрый старт

Этот раздел поможет вам опубликовать первый сайт с помощью GitVerse Pages за пару минут.

1. Минимальная подготовка проекта

Для успешной публикации достаточно одного из файлов в корне репозитория:

index.md;
index.html;
README.md.

2. Создание ветки для публикации

Вы можете использовать любую ветку. Под страничку проекта чаще всего выделяют отдельную ветку pages или используют существующую master.

GitVerse Pages будет собирать проект из выбранной ветки в настройках.

3. Включение GitVerse Pages

⚠️

Для работы с GitVerse Pages есть ряд ограничений:

репозиторий, с которым вы работаете — публичный;
в настройках репозитория включен CI/CD;
username или org-name владельца репозитория не содержит точек;
название репозитория не начинается с точки.

Откройте настройки репозитория:

Настройки → Страницы

Выполните:

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

После сохранения система автоматически запустит сборку.

4. Статус публикации и логи работы

Как только сборка и публикация запущены, на текущей странице можно:

Отследить готовность вашей Страницы.
Перейти по ссылке на конкретный лог сборки в CI/CD.
Снять с публикации вашу Страницу или заново опубликовать.

После успешной сборки и публикации Страница будет доступна по адресу: https://<username>.gitverse.site/<repository>/

Также ссылка будет и на главной странице репозитория в блоке справа:

Как это работает?

Процесс сборки

Сборка выполняется в несколько этапов:

Проверка структуры проекта.
Подключение пользовательских версий Gemfile, _config.yml, _layouts. Если файлов нет — GitVerse Pages автоматически подставляет стандартные версии из официального репозитория сборщика:

https://gitverse.ru/actions/jekyll-build-pages

Запуск Jekyll со следующими характеристиками:

JEKYLL_ENV=production (по умолчанию);
включен режим относительных путей;
используются только поддерживаемые GitVerse Pages плагины.

Генерация каталога _site.
Публикация результата в S3-хранилище.
Раздача контента через CDN и Nginx.

Что система создает автоматически

Файл	Автоматическая подстановка	Назначение
`Gemfile`	при отсутствии	Подключение Jekyll и поддерживаемых плагинов
`_config.yml`	при отсутствии	Базовая конфигурация, включая относительные пути
`_layouts/default.html`	при отсутствии	Основной макет страниц при генерации Jekyll

Если вы хотите переопределить настройки или тему, добавьте собственные файлы — они всегда имеют приоритет над встроенными.
Пример простого блога на Jekyll смотрите в разделе практические руководства.

Приоритет стартовых файлов

Если в корне находятся несколько потенциальных файлов главной страницы, GitVerse Pages использует следующий порядок:

index.html.
index.md.
README.md.

Если сборка завершилась с ошибками

Проверьте:

корректность структуры проекта;
конфигурацию _config.yml (если он кастомный);
используемые плагины и тему.

Обзор и введение Практические руководства