Generator README.md
Isi formulir singkat dan dapatkan README.md GitHub yang rapi dengan badge, instalasi, penggunaan, fitur, kontribusi, dan lisensi, plus pratinjau Markdown langsung.
owner/repo, dipakai untuk badge dan perintah git clone.
Satu fitur per baris.
Judul bagian ditulis dalam bahasa Inggris, konvensi umum README open source. Teks Anda sendiri tetap seperti yang diketik.
Alat Terkait
Lihat SemuaApa itu Generator README?
README adalah file pertama yang dibaca orang di sebuah repositori. Alat ini mengubah beberapa kolom (nama proyek, deskripsi, fitur, perintah instalasi dan penggunaan, lisensi, serta penulis) menjadi README.md yang terstruktur baik, dengan badge shields.io opsional, daftar isi, dan panduan kontribusi. Anda dapat beralih antara sumber Markdown dan Pratinjau hasil render.
Cara menggunakan Generator README
- Masukkan Nama proyek dan, jika ada di GitHub, Repositori GitHub dalam bentuk
owner/repo. - Tambahkan Tagline satu baris, Deskripsi, Fitur (satu per baris), Perintah instalasi, dan Contoh penggunaan.
- Pilih Lisensi, isi Penulis, lalu aktifkan atau nonaktifkan badge, Daftar isi, dan Bagian kontribusi.
- Periksa Pratinjau, lalu salin atau unduh README.md.
Contoh
Project name tiny-cache, tagline "A 1 KB LRU cache", repository acme/tiny-cache, install npm install, license MIT, no badges/TOC/contributing
# tiny-cache > A 1 KB LRU cache ## Installation ```bash git clone https://github.com/acme/tiny-cache.git cd tiny-cache npm install ``` ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Kapan menggunakan Generator README
Pakai untuk memulai README pustaka baru, CLI, proyek sampingan, atau repositori internal dalam semenit, lalu sempurnakan teksnya secara manual. Hasilnya kerangka yang masuk akal, bukan dokumentasi: Anda tetap perlu menjelaskan konfigurasi, detail API, dan contoh yang khusus untuk proyek Anda.
Cara kerja Generator README
Formulir dirakit menjadi Markdown gaya GitHub: H1 berisi nama, badge opsional (lisensi, bintang, isu dari img.shields.io, ditautkan ke repositori), tagline berupa blockquote, lalu bagian Fitur, Instalasi (dengan blok git clone + cd bila repositori diisi), Penggunaan (blok kode berpagar dalam bahasa pilihan Anda), Kontribusi, Lisensi, dan Penulis. Tautan daftar isi mengikuti aturan anchor heading GitHub. Pratinjau dirender dengan marked dan disanitasi dengan DOMPurify.
Kasus Penggunaan Umum
- Memulai README paket open source baru
- Menyeragamkan struktur README di repositori tim
- Menambahkan bagian lisensi dan kontribusi dengan cepat
- Membuat README untuk portofolio atau proyek hackathon
Pertanyaan Umum
Apakah file LICENSE juga dibuat?
Tidak. Alat ini menambahkan bagian Lisensi yang menaut ke LICENSE; tambahkan teks lisensinya sendiri ke repositori Anda (GitHub dapat membuatkannya).
Mengapa heading-nya berbahasa Inggris?
Heading bagian dalam bahasa Inggris adalah konvensi untuk README open source dan memudahkan kontributor di seluruh dunia memindai proyek. Teks Anda sendiri tetap dalam bahasa apa pun yang Anda tulis.
Apakah badge berfungsi untuk repositori privat?
Shields.io tidak dapat membaca repositori GitHub privat, jadi badge bintang dan isu hanya menampilkan data untuk repositori publik.