Softonic

Генератор бейджей README

Шаг 1 / 2 Уценка
Результаты

Введите надпись, сообщение и цвет, и этот генератор создаст статический бейдж shields.io: ту самую плоскую «пилюлю», которую вы видите под заголовком README (build | passing, license | MIT, version | 1.4.0). Он показывает живой предпросмотр и выдаёт как код Markdown, так и HTML для вставки. Shields.io является де-факто сервисом бейджей для проектов с открытым исходным кодом; формат URL прост, но неудобен для запоминания, поэтому небольшой графический интерфейс экономит несколько минут при настройке нового репозитория.

Как создать бейдж

  1. 1

    Введите надпись и сообщение

    Слева располагается надпись на сером фоне, а справа отображается сообщение. Напишите то, что должен показывать бейдж: `build` / `passing`, `coverage` / `98%`, `license` / `MIT`.

  2. 2

    Выберите цвет

    Именованный цвет (brightgreen, blue, red, orange) или шестнадцатеричный код вроде `#ff0000`. Он заполняет правую половину бейджа.

  3. 3

    Настройте стиль

    Выберите стиль (`flat`, `flat-square`, `for-the-badge`, `plastic`, `social`) и при желании логотип по его слагу simple-icons (github, npm, docker).

  4. 4

    Скопируйте Markdown или HTML

    Вставьте код в свой README. Добавьте необязательный URL ссылки, чтобы бейдж стал кликабельным. Shields.io отображает SVG по запросу.

Типичные рецепты бейджей

Этот инструмент создаёт статическую форму badge/label-message-color. Для бейджей с «живыми» данными (статус сборки, версия, загрузки) скопируйте один из шаблонов URL shields.io ниже и вставьте его прямо в свой README.

Назначение Шаблон URL shields.io
Версия npm https://img.shields.io/npm/v/{package}
Загрузки npm https://img.shields.io/npm/dm/{package}
Звёзды на GitHub https://img.shields.io/github/stars/{owner}/{repo}
Последний коммит на GitHub https://img.shields.io/github/last-commit/{owner}/{repo}
Статус рабочего процесса GitHub https://img.shields.io/github/actions/workflow/status/{owner}/{repo}/{workflow.yml}
Лицензия https://img.shields.io/github/license/{owner}/{repo}
Версия PyPI https://img.shields.io/pypi/v/{package}
Загрузки Docker https://img.shields.io/docker/pulls/{org}/{image}
Покрытие Codecov https://img.shields.io/codecov/c/github/{owner}/{repo}
Статическая метка https://img.shields.io/badge/{label}-{message}-{color}

Сравнение стилей бейджей

  • flat, классические скруглённые прямоугольники. По умолчанию.
  • flat-square, острые углы, чуть более современный вид.
  • for-the-badge, прописные буквы вразрядку, максимум внимания.
  • plastic, градиент и внутренняя тень, олдскульный стиль.
  • social, скруглённые углы и приглушённые цвета, под стать кнопкам «звезда»/«форк» самого GitHub.

Когда использовать бейджи

  • Сборка + покрытие, показывает посетителям, что проект действительно поддерживается.
  • Версия + загрузки, показывает, что им пользуются.
  • Лицензия, юридический сигнал для всех, кто думает о вкладе или использовании.
  • Ссылка на документацию, внешний сайт документации или rustdoc.rs.
  • Чат / поддержка, ссылка на Discord, Matrix или GitHub Discussions.

Когда не стоит использовать бейджи

  • Тщеславные метрики, которые никогда не обновляются. Бейдж «звёзды» для репозитория с 0 звёзд создаёт впечатление мёртвого проекта.
  • Все возможные метрики. Пять бейджей рассказывают историю; пятнадцать не говорят ничего.
  • Дублированная информация. Лицензия и «MIT» дважды или версия, показанная и бейджем, и в первой строке текста.
  • Бейджи для сервисов, которыми вы не пользуетесь. Не добавляйте Codecov, если у вас не настроены отчёты о покрытии; сломанный бейдж хуже, чем его отсутствие.

Кэширование и надёжность

Shields.io агрессивно кэширует запросы. Медленно обновляющемуся бейджу обычно достаточно сброса кэша (добавьте ?v=2) или пары минут. Если shields.io недоступен, GitHub показывает слово «shields» без картинки; об этом стоит помнить, но сервис быстро восстанавливается.

Часто задаваемые вопросы

Нет. Shields.io бесплатен и финансируется за счёт пожертвований. Пользователей с очень большим объёмом запросов просят разворачивать сервис самостоятельно или поддерживать проект.

Да. Shields, проект с открытым исходным кодом; его можно запустить на собственном домене. Большинству проектов это не нужно: бесплатный сервис надёжен.

Кэширование. Добавьте ?cacheSeconds=60 или ?v=anything, чтобы принудительно обновить данные. Распространение может занять до нескольких минут.

Да, добавьте ?logo=github (или любой слаг simple-icons). Используйте ?logoColor=white, чтобы изменить цвет иконки.

Нет. Всё выполняется в браузере, а URL-адреса генерируются на стороне клиента для копирования.

Сопутствующие инструменты

Справочная таблица ASCII

Полная таблица ASCII от 0 до 127 с десятичным, шестнадцатеричным, восьмеричным и двоичным представлением, а также записью числовых ссылок HTML, включая NUL, LF и DEL.

Справочник символов HTML

Справочник HTML-сущностей с поиском, их именованными и числовыми кодами, а также копированием специальных символов и знаков одним кликом.

Справочник сочетаний клавиш

Ищите документированные сочетания по умолчанию для VS Code, Chrome и Bash с GNU Readline в macOS, Windows и Linux.

Конвертер размера файлов

Преобразуйте значения между байтами, КБ, МБ, ГБ, ТБ и двоичными единицами IEC (KiB, MiB, GiB, TiB), свободно сочетая десятичные и двоичные единицы.

Генератор случайных букв

Генерируйте случайные буквы A-Z. Выберите количество, верхний или нижний регистр либо смешанный вариант для игр, заданий и уроков.

Конвертер CMYK в RGB

Преобразуйте проценты CMYK в приблизительные значения RGB и Hex для быстрого экранного предпросмотра по стандартной формуле.

Инструмент доступен на других языках