Apa itu Markdown? Panduan Menulis File README.md untuk Pemula

Selamat Tinggal Microsoft Word!

Sebagai programmer, kamu tidak akan mendokumentasikan kodemu menggunakan Microsoft Word (.docx). Para developer menggunakan format teks yang sangat ringan, bisa dibaca di terminal, tapi tetap bisa diubah menjadi tampilan yang cantik saat diunggah ke internet. Format itu disebut Markdown (.md).

Apa itu Markdown?

Markdown adalah bahasa markup (seperti HTML) namun jauh lebih sederhana. Daripada menulis Teks Tebal yang memusingkan, di Markdown kamu cukup menulis **Teks Tebal**. Saat file ini diunggah ke platform seperti GitHub, platform tersebut akan otomatis mengubah simbol bintang itu menjadi teks tebal sungguhan.

Sintaks Dasar Markdown yang Wajib Dihafal

Berikut adalah beberapa aturan penulisan (cheatsheet) yang paling sering digunakan dalam penulisan file README.md:

• Judul (Headings): Gunakan tanda pagar (hashtag). Satu pagar untuk H1 (paling besar), dua pagar untuk H2, dan seterusnya. Contoh: # Ini Judul Utama
• Tebal (Bold) & Miring (Italic): Gunakan tanda bintang. *Teks Miring* dan **Teks Tebal**.
• Daftar (Lists): Cukup gunakan tanda strip (-) untuk daftar peluru (bullet). Contoh: - Item pertama
• Link (Tautan): Teks yang bisa diklik dibungkus kurung siku, URL-nya dibungkus kurung biasa. Contoh: [Kunjungi Google](https://google.com)

Menulis Kode (Code Blocks)

Ini adalah fitur paling disukai developer. Jika kamu ingin menampilkan cuplikan kode di dokumentasimu, gunakan tiga tanda backtick (```) yang berada di bawah tombol Esc pada keyboardmu.

```javascript
function sapa() {
  console.log("Halo Dunia!");
}
```

GitHub akan mendeteksi kata "javascript" tersebut dan otomatis memberikan warna khusus (Syntax Highlighting) pada kodemu!

Kesimpulan

File README.md adalah "etalase" dari project coding-mu. Mulailah biasakan menulis Markdown di setiap project yang kamu buat. Selain untuk dokumentasi, Markdown saat ini juga banyak digunakan di aplikasi pencatat (note-taking) seperti Notion dan Obsidian.