Генератор бэджей Markdown
Создавайте бэджи shields.io для README и оборачивайте их в Markdown, HTML или reStructuredText.
Генератор бэджей Markdown
Каждый README со статусом сборки, номером версии или иконкой лицензии в верхней части использует бэдж shields.io — это небольшое SVG, собранное из метки, значения и цвета. Этот инструмент создает бэдж за вас: заполните метку, значение и цвет, выберите стиль и дополнительный логотип, и он соберет URL shields.io и обернет его в разметку, которую использует ваш проект.
Опция стиля охватывает все пять рендеринга shields.io — flat, flat-square, plastic, for-the-badge и social — а поле логотипа принимает любой simple-icons slug (github, npm, docker и сотни других), подкрашенный цветом логотипа, когда вы хотите, чтобы он соответствовал бэджу. Добавьте ссылку — и бэдж становится кликабельным на отрисованной странице; добавьте альтернативный текст — и он остается понятным для экранного читателя. Переключение формата вывода между Markdown, HTML и reStructuredText позволяет одному и тому же бэджу попадать прямо в README, на сайт документации или в проект Sphinx без ручного редактирования разметки.
Создание более одного бэджа одновременно — это то, для чего нужен второй ящик: вставьте список, по одному бэджу на строку в виде label|value|color, и инструмент превратит его в ряд бэджей рядом — паттерн, который вы видите под заголовком проекта с build, coverage, version и license в одной линии. Включите сортировку, чтобы упорядочить этот ряд по алфавиту, или добавьте таблицу бэджей, чтобы также отрисовать тот же набор как справку из двух колонок. Опция escape обрабатывает одну особенность shields.io, которая путает людей: буквальный дефис или пробел внутри метки должны быть удвоены или заменены перед тем, как URL станет валидным, и этот инструмент делает это автоматически, если вы не отключите это.
Все работает в вашем браузере. Метка, значение и любой список, который вы вставляете, используются только для создания строки URL локально — ничего не загружается, и инструмент никогда не связывается с shields.io самостоятельно, он просто пишет ссылку. Скопируйте результат, загрузите его как .txt файл или отправьте на ввод другого инструмента, чтобы продолжить редактирование.