Generator odznak markdown
Twórz odznaki shields.io dla README i owijaj je w markdown, HTML lub reStructuredText.
Generator odznak markdown
Każdy README ze statusem kompilacji, numerem wersji lub ikoną licencji w górnej części używa odznaki shields.io — małego SVG złożonego z opisu, wartości i koloru. To narzędzie tworzy dla Ciebie ten odznak: wypełnij opis, wartość i kolor, wybierz styl i opcjonalne logo, a wygeneruje adres URL shields.io i owinie go w markdown, którego Twój projekt faktycznie używa.
Wszystkie pięć stylów shields.io — flat, flat-square, plastic, for-the-badge i social — są dostępne w opcji stylu, a pole logo akceptuje dowolny slug z simple-icons (github, npm, docker i setki innych), zabarwiony kolorem logo, gdy chcesz, aby pasował do odznaki. Dodaj link, a odznak staje się klikalalny na renderowanej stronie; dodaj tekst alternatywny i pozostaje znaczący dla czytników ekranu. Przełączanie formatu wyjścia między markdown, HTML i reStructuredText oznacza, że ten sam odznak trafia bezpośrednio do README, witryny dokumentacji lub projektu Sphinx bez ręcznego edytowania znaczników.
Tworzenie więcej niż jednego odznaki naraz to do czego służy drugie pole: wklej listę, jeden odznak na linię jako opis|wartość|kolor, a narzędzie zamienia go w rząd odznak obok siebie — wzorzec, który widzisz pod tytułem projektu ze statusem, pokryciem, wersją i licencją w jednym wierszu. Włącz sortowanie, aby uporządkować ten rząd alfabetycznie, lub dodaj tabelę odznak i renderuj ten sam zestaw jako dwukolumnową referencję. Opcja escape rozwiązuje jedną pułapkę shields.io, która myli ludzi: doslowny myślnik lub spacja w opisie muszą być podwojone lub zastąpione, zanim adres URL będzie ważny, a narzędzie robi to automatycznie, chyba że je wyłączysz.
Wszystko działa w Twojej przeglądarce. Opis, wartość i wszystkie listy zbiorcze, które wklejasz, są używane tylko do lokalnego budowania ciągu URL — nic się nie przesyła, a narzędzie nigdy nie kontaktuje się z samym shields.io, po prostu pisze link. Skopiuj wynik, pobierz go jako plik .txt lub wyślij go do wejścia innego narzędzia, aby kontynuować edycję.