Softonic

Generator odznak README

Krok 1 / 2 Markdown
Wyniki

Wpisz etykietę, komunikat i kolor, a ten generator utworzy statyczną odznakę shields.io: tę małą, płaską pigułkę, którą widzisz pod tytułem README (build | passing, license | MIT, version | 1.4.0). Pokazuje podgląd na żywo i daje zarówno kod Markdown, jak i HTML do wklejenia. Shields.io to de facto standardowa usługa odznak dla projektów open source; format adresu jest prosty, ale uciążliwy do zapamiętania, więc mały interfejs graficzny oszczędza kilka minut przy zakładaniu nowego repozytorium.

Jak zbudować odznakę

  1. 1

    Wpisz etykietę i komunikat

    Etykieta to lewa połowa (szara), a komunikat to prawa. Wpisz to, co ma pokazywać odznaka: `build` / `passing`, `coverage` / `98%`, `license` / `MIT`.

  2. 2

    Wybierz kolor

    Kolor nazwany (brightgreen, blue, red, orange) albo kod szesnastkowy, jak `#ff0000`. Wypełnia prawą połowę odznaki.

  3. 3

    Nadaj styl

    Wybierz styl (`flat`, `flat-square`, `for-the-badge`, `plastic`, `social`), a opcjonalnie logo za pomocą sluga simple-icons (github, npm, docker).

  4. 4

    Skopiuj Markdown lub HTML

    Wklej do swojego README. Dodaj opcjonalny adres URL linku, aby odznaka była klikalna. Shields.io renderuje SVG na żądanie.

Częste przepisy na odznaki

To narzędzie tworzy statyczną formę badge/label-message-color. Jeśli potrzebujesz odznak z danymi na żywo (status budowania, wersja, pobrania), skopiuj jeden ze wzorów adresów shields.io poniżej i wklej go bezpośrednio do swojego README.

Cel Wzór adresu shields.io
Wersja npm https://img.shields.io/npm/v/{package}
Pobrania npm https://img.shields.io/npm/dm/{package}
Gwiazdki GitHub https://img.shields.io/github/stars/{owner}/{repo}
Ostatni commit GitHub https://img.shields.io/github/last-commit/{owner}/{repo}
Status workflow GitHub https://img.shields.io/github/actions/workflow/status/{owner}/{repo}/{workflow.yml}
Licencja https://img.shields.io/github/license/{owner}/{repo}
Wersja PyPI https://img.shields.io/pypi/v/{package}
Pobrania Docker https://img.shields.io/docker/pulls/{org}/{image}
Pokrycie Codecov https://img.shields.io/codecov/c/github/{owner}/{repo}
Etykieta statyczna https://img.shields.io/badge/{label}-{message}-{color}

Porównanie stylów odznak

  • flat, klasyczne zaokrąglone prostokąty. Domyślny.
  • flat-square, ostre rogi, nieco nowocześniej.
  • for-the-badge, wersaliki w bloku, maksimum uwagi.
  • plastic, gradient i wcięty cień, w starym stylu.
  • social, zaokrąglone rogi i stonowane kolory, pasuje do własnych przycisków gwiazdki/forka GitHuba.

Kiedy używać odznak

  • Budowanie + pokrycie, mówi odwiedzającym, że projekt jest faktycznie utrzymywany.
  • Wersja + pobrania, mówi im, że jest używany.
  • Licencja, sygnał prawny dla każdego, kto rozważa wkład lub użycie.
  • Link do dokumentacji, zewnętrzna strona docs albo rustdoc.rs.
  • Czat / wsparcie, link do Discorda, Matriksa, GitHub Discussions.

Kiedy nie używać odznak

  • Statystyki próżności, które nigdy się nie aktualizują. Odznaka „gwiazdki” dla repozytorium z 0 gwiazdkami sprawia, że projekt wygląda na martwy.
  • Każda możliwa metryka. Pięć odznak opowiada historię; piętnaście nie mówi nic.
  • Zdublowane informacje. Licencja + „MIT” dwa razy albo wersja pokazana zarówno jako odznaka, jak i w pierwszej linii tekstu.
  • Odznaki usług, których nie używasz. Nie dodawaj Codecov, jeśli nie masz skonfigurowanego raportowania pokrycia, zepsuta odznaka jest gorsza niż brak odznaki.

Cache’owanie i niezawodność

Shields.io agresywnie cache’uje żądania. Odznaka, która aktualizuje się wolno, zwykle potrzebuje tylko wyczyszczenia cache (dopisz ?v=2) albo kilku minut. Jeśli shields.io jest niedostępny, GitHub renderuje „shields” bez grafiki, warto o tym wspomnieć, ale wraca do sprawności szybko.

Najczęściej zadawane pytania

Nie. Shields.io jest darmowy i finansowany z darowizn. Użytkowników o bardzo dużym wolumenie prosi się o self-hosting albo wsparcie projektu.

Tak. Shields jest open source; możesz go uruchomić pod własną domeną. Większość projektów nie musi: darmowa usługa jest niezawodna.

Cache. Dopisz ?cacheSeconds=60 albo ?v=cokolwiek, aby wymusić odświeżenie. Spodziewaj się do kilku minut propagacji.

Tak: dodaj ?logo=github (albo dowolny slug simple-icons). Użyj ?logoColor=white, aby dostosować kolor ikony.

Nie. Wszystko działa w przeglądarce, a adresy są generowane po stronie klienta do skopiowania.

Powiązane narzędzia

Tabela ASCII

Pełna tabela ASCII od 0 do 127 z zapisem dziesiętnym, szesnastkowym, ósemkowym i binarnym oraz notacją numerycznych odwołań HTML, w tym kodami sterującymi NUL, LF i DEL.

Referencja znaków HTML

Przeszukiwalna lista encji HTML wraz z ich kodami nazwanymi i liczbowymi oraz kopiowaniem jednym kliknięciem specjalnych znaków i symboli.

Skróty klawiaturowe

Wyszukuj udokumentowane skróty domyślne VS Code, Chrome i Bash z GNU Readline w macOS, Windows i Linux.

Generator EditorConfig

Zbuduj plik .editorconfig z własnych reguł wcięć, końca linii i kodowania, a potem dodaj poprawną sekcję dla każdego języka w repozytorium: Python, Go, YAML, Makefile i więcej.

Walidator adresów e-mail

Zweryfikuj adres e-mail: sprawdzenie składni RFC 5322, sprawdzenie rekordu MX w czasie rzeczywistym oraz szczegóły dotyczące części lokalnej, domeny i długości. Żadna wiadomość nie jest wysyłana.

Formatowanie HTML

Formatuj HTML lokalnie w przeglądarce, używając wcięć dwóch lub czterech spacji. HTML nie jest wysyłany ani walidowany.

Narzędzie jest dostępne w innych językach