Генератор бейджів 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 в одній лінії. Увімкніть сортування, щоб упорядкувати цей рядок за алфавітом, або додайте таблицю бейджів, щоб також відрисувати той самий набір як довідку з двох колонок. Опція екранування обробляє одну особливість shields.io, яка вводить людей в оману: літеральна дефіс або пробіл всередині мітки повинні бути подвоєні або замінені перед тим, як URL стане чинним, і цей інструмент робить це автоматично, якщо ви не відключите його.
Все працює у вашому браузері. Мітка, значення та будь-який список, який ви вставляєте, використовуються лише для створення рядка URL локально — нічого не завантажується, і інструмент ніколи не звертається до shields.io самостійно, він просто пише посилання. Скопіюйте результат, завантажте його як файл .txt або відправте на ввід іншого інструменту, щоб продовжити редагування.