Softonic

README Rozet Üreteci

Adım 1 / 2 Markdown
Sonuçlar

README’nizde bir etiket, bir mesaj ve bir renk yazın; bu üreteç statik bir shields.io rozeti oluşturur: README başlığının altında gördüğünüz o küçük, yassı hap (build | passing, license | MIT, version | 1.4.0). Canlı bir önizleme gösterir ve yapıştırmanız için hem Markdown’ı hem de HTML’i verir. Shields.io, açık kaynak projeler için fiili rozet hizmetidir; URL biçimi basittir ama ezberlemesi can sıkıcıdır, bu yüzden küçük bir grafik arayüz, yeni bir depo kurarken birkaç dakika kazandırır.

Bir rozet nasıl oluşturulur

  1. 1

    Etiketi ve mesajı yazın

    Etiket sol yarıdır (gri); mesaj sağ yarıdır. Rozetin ne göstermesini istiyorsanız onu yazın: `build` / `passing`, `coverage` / `98%`, `license` / `MIT`.

  2. 2

    Bir renk seçin

    Adlandırılmış bir renk (brightgreen, blue, red, orange) veya `#ff0000` gibi bir onaltılık kod. Rozetin sağ yarısını doldurur.

  3. 3

    Biçimlendirin

    Bir stil (`flat`, `flat-square`, `for-the-badge`, `plastic`, `social`) ve isteğe bağlı olarak simple-icons slug'ı ile bir logo (github, npm, docker) seçin.

  4. 4

    Markdown'ı veya HTML'i kopyalayın

    README'nize yapıştırın. Rozeti tıklanabilir yapmak için isteğe bağlı bağlantı URL'sini ekleyin. Shields.io istek üzerine SVG işler.

Yaygın rozet tarifleri

Bu araç statik badge/label-message-color biçimini oluşturur. Canlı veri gösteren rozetler (derleme durumu, sürüm, indirmeler) için aşağıdaki shields.io URL desenlerinden birini kopyalayıp doğrudan README’nize yapıştırın.

Amaç Shields.io URL deseni
npm sürümü https://img.shields.io/npm/v/{package}
npm indirmeleri https://img.shields.io/npm/dm/{package}
GitHub yıldızları https://img.shields.io/github/stars/{owner}/{repo}
GitHub son commit https://img.shields.io/github/last-commit/{owner}/{repo}
GitHub iş akışı durumu https://img.shields.io/github/actions/workflow/status/{owner}/{repo}/{workflow.yml}
Lisans https://img.shields.io/github/license/{owner}/{repo}
PyPI sürümü https://img.shields.io/pypi/v/{package}
Docker çekmeleri https://img.shields.io/docker/pulls/{org}/{image}
Codecov kapsamı https://img.shields.io/codecov/c/github/{owner}/{repo}
Statik etiket https://img.shields.io/badge/{label}-{message}-{color}

Rozet stili karşılaştırması

  • flat, klasik yuvarlatılmış dikdörtgenler. Varsayılan.
  • flat-square, keskin köşeler, biraz daha modern.
  • for-the-badge, tümü büyük harf blok harfler, maksimum dikkat.
  • plastic, degrade ve içe gölge, eski tarz.
  • social, yuvarlak köşeler ve donuk, GitHub’ın kendi yıldız/fork düğmeleriyle eşleşir.

Rozetler ne zaman kullanılır

  • Derleme + kapsam, ziyaretçilere projenin gerçekten sürdürüldüğünü söyler.
  • Sürüm + indirmeler, kullanımda olduğunu söyler.
  • Lisans, katkı veya kullanımı düşünen herkes için yasal sinyal.
  • Belge bağlantısı, harici belge sitesi veya rustdoc.rs.
  • Sohbet / destek, Discord, Matrix, GitHub Discussions bağlantısı.

Rozetler ne zaman kullanılmaz

  • Hiç güncellenmeyen gösteriş istatistikleri. 0 yıldızlı bir depo için “yıldızlar” rozeti projeyi ölü gösterir.
  • Olası her ölçüt. Beş rozet bir hikâye anlatır; on beş hiçbir şey anlatmaz.
  • Yinelenen bilgi. İki kez lisans + “MIT” ya da hem rozet hem de düzyazının ilk satırı olarak gösterilen sürüm.
  • Kullanmadığınız hizmetler için rozetler. Kapsam raporlaması kurulu değilse Codecov eklemeyin, bozuk rozet, rozet olmamasından daha kötüdür.

Önbellekleme ve güvenilirlik

Shields.io istekleri agresif biçimde önbelleğe alır. Yavaş güncellenen bir rozetin genellikle yalnızca bir önbellek temizliğine (?v=2 ekleyin) veya birkaç dakikaya ihtiyacı vardır. Shields.io çökerse GitHub grafik olmadan “shields” işler, belirtmeye değer ama hızla toparlanır.

Sık Sorulan Sorular

Hayır. Shields.io ücretsizdir ve bağışlarla finanse edilir. Çok yüksek hacimli kullanıcılardan kendi sunucularını kurmaları veya projeyi desteklemeleri istenir.

Evet. Shields açık kaynaktır; kendi alan adınızın arkasında çalıştırabilirsiniz. Çoğu projenin buna ihtiyacı yoktur: ücretsiz hizmet güvenilirdir.

Önbellekleme. Yenilemeyi zorlamak için ?cacheSeconds=60 veya ?v=anything ekleyin. Birkaç dakikaya kadar yayılma bekleyin.

Evet: ?logo=github (veya herhangi bir simple-icons slug) ekleyin. Simge rengini ayarlamak için ?logoColor=white kullanın.

Hayır. Her şey tarayıcıda çalışır ve URL’ler kopyalama için istemci tarafında oluşturulur.

İlgili Araçlar

ASCII Tablosu Referansı

NUL, LF ve DEL dahil her kod için ondalık, onaltılık, sekizlik ve ikili değerlerle HTML sayısal karakter başvurusu gösterimini sunan tam ASCII tablosu.

HTML Karakter Referansı

HTML varlıklarının aranabilir listesi; adlandırılmış ve sayısal kodlarıyla birlikte özel karakter ve semboller için tek tıkla kopyalama.

FPS Sayacı

requestAnimationFrame ile tarayıcı FPS değerini ölçün: yumuşatma, en düşük ve en yüksek kare hızı, uyarı eşiği ve isteğe bağlı grafik. Yerel çalışır, yükleme ve API yoktur.

Klavye kısayolları başvurusu

macOS, Windows ve Linux’ta VS Code, Chrome ve GNU Readline kullanan Bash için belgelenmiş varsayılan kısayolları arayın.

E-posta Doğrulayıcı

Bir e-posta adresini doğrulayın: RFC 5322 sözdizimi kontrolü, canlı MX kaydı sorgulama, ayrıca yerel kısım, alan adı ve uzunluk bilgileri. Hiçbir e-posta gönderilmez.

EditorConfig Oluşturucu

Girinti, satır sonu ve karakter kümesi kurallarınızdan bir .editorconfig oluşturun, ardından deponuzdaki her dil için doğru bölümü ekleyin: Python, Go, YAML, Makefile ve daha fazlası.

Araç diğer dillerde mevcuttur