Softonic

Generator Badge README

Langkah 1 / 2 Markdown
Hasil

Ketik sebuah label, pesan, dan warna, lalu generator ini membuat badge shields.io statis: pil datar kecil yang Anda lihat di bawah judul README (build | passing, license | MIT, version | 1.4.0). Ia menampilkan pratinjau langsung dan memberi Anda cuplikan Markdown sekaligus HTML untuk ditempel. Shields.io adalah layanan badge de facto untuk proyek sumber terbuka; format URL-nya sederhana tetapi merepotkan untuk dihafal, jadi antarmuka grafis kecil menghemat beberapa menit saat Anda menyiapkan repositori baru.

Cara membuat badge

  1. 1

    Tulis label dan pesan

    Label adalah bagian kiri (abu-abu); pesan adalah bagian kanan. Tulis apa pun yang ingin ditampilkan badge: `build` / `passing`, `coverage` / `98%`, `license` / `MIT`.

  2. 2

    Pilih warna

    Warna bernama (brightgreen, blue, red, orange) atau kode heksadesimal seperti `#ff0000`. Warna ini mengisi bagian kanan badge.

  3. 3

    Beri gaya

    Pilih gaya (`flat`, `flat-square`, `for-the-badge`, `plastic`, `social`) dan, opsional, sebuah logo lewat slug simple-icons-nya (github, npm, docker).

  4. 4

    Salin Markdown atau HTML

    Tempelkan ke README Anda. Tambahkan URL tautan opsional agar badge dapat diklik. Shields.io menampilkan SVG sesuai permintaan.

Resep badge umum

Alat ini membuat bentuk statis badge/label-message-color. Untuk badge yang menampilkan data langsung (status build, versi, unduhan), salin salah satu pola URL shields.io di bawah ini dan tempel langsung ke README Anda.

Tujuan Pola URL shields.io
Versi npm https://img.shields.io/npm/v/{package}
Unduhan npm https://img.shields.io/npm/dm/{package}
Bintang GitHub https://img.shields.io/github/stars/{owner}/{repo}
Komit terakhir di GitHub https://img.shields.io/github/last-commit/{owner}/{repo}
Status alur kerja GitHub https://img.shields.io/github/actions/workflow/status/{owner}/{repo}/{workflow.yml}
Lisensi https://img.shields.io/github/license/{owner}/{repo}
Versi PyPI https://img.shields.io/pypi/v/{package}
Pull Docker https://img.shields.io/docker/pulls/{org}/{image}
Cakupan Codecov https://img.shields.io/codecov/c/github/{owner}/{repo}
Label statis https://img.shields.io/badge/{label}-{message}-{color}

Perbandingan gaya badge

  • flat, persegi panjang membulat klasik. Nilai default.
  • flat-square, sudut tajam, terkesan sedikit lebih modern.
  • for-the-badge, huruf kapital tebal, untuk menarik perhatian maksimal.
  • plastic, efek gradien dan bayangan dalam, gaya lawas.
  • social, sudut membulat dan warna lembut, senada dengan tombol bintang/fork milik GitHub.

Kapan menggunakan badge

  • Build + cakupan, menunjukkan kepada pengunjung bahwa proyek benar-benar dipelihara.
  • Versi + unduhan, menunjukkan bahwa proyek sedang digunakan.
  • Lisensi, sinyal hukum bagi siapa pun yang mempertimbangkan berkontribusi atau menggunakannya.
  • Tautan dokumentasi, situs dokumentasi eksternal atau rustdoc.rs.
  • Chat / dukungan, tautan ke Discord, Matrix, atau GitHub Discussions.

Kapan tidak perlu menggunakan badge

  • Statistik pamer yang tidak pernah diperbarui. Badge “bintang” untuk repositori dengan 0 bintang membuat proyek terlihat mati.
  • Setiap metrik yang mungkin. Lima badge menyampaikan sebuah cerita; lima belas badge tidak menyampaikan apa-apa.
  • Informasi ganda. Lisensi + “MIT” dua kali, atau versi ditampilkan sebagai badge sekaligus di baris pertama teks.
  • Badge untuk layanan yang tidak Anda pakai. Jangan tambahkan Codecov jika Anda belum menyiapkan pelaporan cakupan; badge yang rusak lebih buruk daripada tanpa badge.

Caching dan keandalan

Shields.io menyimpan permintaan dalam cache secara agresif. Badge yang lambat diperbarui biasanya hanya perlu penyegaran cache (tambahkan ?v=2) atau beberapa menit saja. Jika shields.io sedang tidak aktif, GitHub menampilkan tulisan “shields” tanpa grafik; layak dicatat, tetapi pulih dengan cepat.

Pertanyaan yang Sering Diajukan

Tidak. Shields.io gratis dan dibiayai lewat donasi. Pengguna dengan volume sangat tinggi diminta untuk meng-host sendiri atau mendukung proyek.

Ya. Shields bersifat sumber terbuka; Anda dapat menjalankannya di domain sendiri. Sebagian besar proyek tidak perlu melakukannya: layanan gratisnya andal.

Caching. Tambahkan ?cacheSeconds=60 atau ?v=anything untuk memaksa pembaruan. Perkirakan hingga beberapa menit untuk penyebarannya.

Ya, tambahkan ?logo=github (atau slug simple-icons apa pun). Gunakan ?logoColor=white untuk mengatur warna ikon.

Tidak. Semua berjalan di peramban, dan URL dibuat di sisi klien untuk disalin.

Alat Terkait

Referensi Tabel ASCII

Tabel ASCII lengkap dari 0 sampai 127 dengan desimal, heksadesimal, oktal, biner, dan referensi karakter numerik HTML untuk setiap karakter, termasuk kode kontrol seperti NUL, LF, dan DEL.

Referensi Karakter HTML

Daftar entitas HTML yang dapat dicari, beserta kode bernama dan kode numeriknya, serta fitur salin dengan satu klik untuk karakter khusus dan simbol.

Referensi pintasan papan ketik

Cari pintasan bawaan terdokumentasi untuk VS Code, Chrome, dan Bash dengan GNU Readline di macOS, Windows, dan Linux.

Generator EditorConfig

Buat file .editorconfig dari aturan indentasi, akhir baris, dan charset Anda, lalu tambahkan bagian yang tepat untuk tiap bahasa di repositori Anda: Python, Go, YAML, Makefile, dan lainnya.

Validator Email

Validasi alamat email: pemeriksaan sintaks RFC 5322, pengecekan live record MX, serta detail bagian lokal, domain, dan panjang. Tidak ada email yang dikirim.

Konverter Ukuran File

Konversi antara byte, KB, MB, GB, TB, dan satuan biner IEC (KiB, MiB, GiB, TiB) dengan kombinasi desimal dan biner apa pun yang Anda inginkan.

Alat ini tersedia dalam bahasa lain