Руководства для проектов

Изображение предпросмотра GitHub для соцсетей: размер, настройка и проверка

Социальное превью репозитория — изображение, которое люди могут увидеть при публикации ссылки на него. Используйте его, чтобы быстро объяснить проект: короткое название, одно полезное обещание и узнаваемый пример. Оно дополняет README, а не заменяет его.

Редакция GitHubStart · Обновлено

Подготовьте подходящий файл

Согласно текущим рекомендациям GitHub, принимаются файлы PNG, JPG или GIF размером менее 1 МБ. Рекомендуется минимум 640 × 320 пикселей, а для наилучшего отображения — 1280 × 640. Начните с большего холста 2:1, затем проверьте читаемость при значительном уменьшении.

Для вымышленного валидатора CSV понятный макет может содержать название проекта, фразу «Проверяйте CSV-файлы перед импортом» и простой пример от входных данных до ошибки. Не пытайтесь втиснуть целый сеанс терминала в миниатюру. Держите важный текст подальше от краёв на случай обрезки изображения площадкой публикации.

Загрузите изображение и проверьте опубликованную ссылку

Откройте Settings репозитория, найдите Social preview, выберите Edit и загрузите изображение. Опубликуйте URL публичного репозитория там, где его увидит ваша аудитория. Проверьте результат именно там: успешная загрузка не гарантирует, что каждая платформа немедленно заменит закешированное превью.

  • Убедитесь, что изображение относится к репозиторию, ссылкой на который вы делитесь.
  • Перед загрузкой проверьте формат файла, размеры в пикселях и размер файла.
  • Обеспечьте читаемый контраст; проверьте прозрачные изображения на светлом и тёмном фоне.
  • Если изображение устарело, проверьте сохранённую настройку репозитория и изучите кеш платформы публикации.

Согласуйте превью с проектом

Используйте одинаковые название и назначение проекта на изображении, в README и объявлении о выпуске. Если снимок экрана показывает экспериментальную функцию, обозначьте это или покажите стабильный сценарий работы. Не добавляйте вымышленные количества звёзд, логотипы клиентов или заявления о производительности.

Пересматривайте изображение, когда меняется основной сценарий использования проекта. Превью — средство коммуникации, а не отдельная гарантия позиций в поиске, кликабельности или звёзд GitHub.

Частые вопросы

Это то же самое, что аватар владельца репозитория?

Нет. Аватар владельца обозначает учётную запись. Настраиваемое социальное превью представляет конкретный проект при публикации ссылки на него.

Можно ли использовать прозрачный фон в превью?

GitHub поддерживает прозрачность PNG. Проверьте контраст на разных фонах; сплошной фон — практичный выбор, если внешний вид площадки публикации неизвестен.

Почему после загрузки я всё ещё вижу старое превью?

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

Источники