Некоторые особенности использования GitVerse Pages

Info

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

Требования к названию аккаунта

Warning

Название аккаунта пользователя или название организации не должны содержать точек. Это требование связано с формированием поддоменов и внутренними правилами DNS.

Требования к репозиторию

1. Доступность

• репозиторий должен быть публичным;
• в тарифе GitVerse Pro будет доступна публикация Pages из приватных репозиториев.

2. Наличие файлов

• репозиторий не должен быть пустым;
• для сборки необходимы index.md, или index.html, или README.md, или структура Jekyll;
• если в корне есть index.md и index.html, index.md игнорируется.

3. Активированный CI/CD

GitVerse Pages запускает публикацию через GitVerse CI/CD, поэтому в репозитории должен быть включен функционал «CI/CD».

Названия файлов: правила и ограничения

Info

Jekyll чувствителен к структуре и имени файлов. Неправильное название может привести к тому, что файл будет проигнорирован.

Нельзя:

• начинать имя с подчеркивания, если это не _layouts, _includes, _posts, _data;
• использовать пробелы: мой пост.md;
• использовать кириллицу: новости.md;
• добавлять спецсимволы: photo@home.jpg;
• ставить точки в середине или двойные точки: config.local.json, file..txt;
• называть файлы в конфликте со служебными каталогами: posts.md, site.html;
• использовать неподдерживаемые расширения: .py, .zip, .exe.

Ограничения и лимиты

Лимиты GitVerse Pages

• время на сборку Страниц идет из общего лимита на сборочное время CI/CD;
• артефакты Страниц расходуют лимит на сборочные артефакты;
• итоговый артефакт сборки ≤ 500 МБ;
• в корне ветки должен присутствовать один из файлов:
  • index.md;
  • index.html;
  • README.md.

Справочная информация

Преобразование имен репозиториев

Точки в репозиториях автоматически заменяются на дефисы: my.project → my-project.

Поддерживаемый генератор статики

• **jekyll 3.9.*;
• сборка выполняется автоматически с использованием нашего builder-а.

Логи сборки

Логи сборки и публикации GitVerse Pages доступны здесь:

• в интерфейсе Репозиторий → Настройки → Страницы отображается ссылка «Открыть запуск сборки»;
• на вкладке CI/CD – в workflow c названием build-and-deploy-pages.

Срок хранения артефактов

По умолчанию — 1 день. Затем артефакты автоматически удаляются.

Работа со ссылками и структурой

Формат относительных ссылок

Warning

Ссылки на ресурсы лучше всего публиковать через | relative_url Это критично для корректной работы сайта при подстановке baseurl.

Пример:

Неправильно ❌	Правильно ✅
/about.html	{{ '/about.html' | relative_url }}
assets/style.css	{{ '/assets/css/style.css' | relative_url }}

Чувствительность к регистру

About.md и about.md — разные файлы.