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

Info

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

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

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

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

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

index.html > index.md > README.md

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

Вы можете использовать любую ветку. Под страничку проекта чаще всего выделяют отдельную ветку pages или используют существующую master.
По умолчанию используются файлы из корня репозитория /root. Но вы можете выбрать одну из папок: /docs, /site, /public, /out, откуда будет публикация.

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

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

Warning

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

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

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

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

Выполните:

  1. Включите функциональность тумблером.
  2. Выберите источник Ветка.
  3. Выберите ветку, из которой будет выполняться сборка.
  4. Можете выбрать папку, из которой будет выполняться сборка. По умолчанию выбрано /root.
  5. Сохраните настройки.

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

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

После запуска сборки и публикации на этой странице можно:

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

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

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

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

Проверьте:

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

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

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

Подробное описание процесса сборки и публикации сайта на Jekyll смотрите в разделе справочная документация

Вид графа

Связанные страницы