Cara menggunakan editor Markdown
- Ketik atau tempel Markdown ke editor di sebelah kiri.
- Perhatikan pratinjau langsung yang diperbarui saat Anda mengetik, dirender dengan GitHub-flavoured Markdown (GFM).
- Klik Salin HTML untuk menyalin HTML yang dihasilkan untuk situs web, CMS, atau email.
- Atau salin Markdown-nya sendiri untuk README, issue, pull request, atau halaman dokumentasi.
Perenderan berjalan di browser Anda, dan teks Anda tidak diunggah atau disimpan. HTML yang dirender disanitasi, sehingga skrip dan atribut berbahaya dalam konten yang ditempel dihapus sebelum pratinjau ditampilkan.
Apa itu Markdown?
Markdown adalah bahasa markup ringan yang dibuat oleh John Gruber pada 2004. Markdown memakai tanda baca teks biasa untuk pemformatan: # untuk heading, * atau _ untuk penekanan, - untuk daftar. Sumbernya tetap terbaca sebagai teks biasa, dan renderer mengubahnya menjadi HTML.
Deskripsi aslinya tidak mendefinisikan banyak kasus khusus, sehingga setiap implementasi menanganinya secara berbeda. CommonMark adalah spesifikasi rinci yang menyelesaikan ambiguitas itu, dan GitHub-flavoured Markdown adalah superset CommonMark yang menambahkan fitur yang dipakai developer setiap hari:
| Fitur GFM | Sintaks |
|---|---|
| Tabel | | Name | Value | dengan baris pemisah |---|---| |
| Daftar tugas | - [ ] todo dan - [x] done |
| Teks dicoret (strikethrough) | ~~removed~~ |
| Autolink | URL polos seperti https://example.com menjadi tautan |
| Blok kode berpagar (fenced) | Tiga backtick, boleh diikuti nama bahasa |
Referensi cepat Markdown
# Heading 1
## Heading 2
**bold**, *italic*, `inline code`
- Bullet item
- Nested item (indent two spaces)
1. Numbered item
[Link text](https://example.com)

> A blockquote
```python
print("fenced code with a language")
```
Masalah Markdown yang umum dan cara memperbaikinya
Heading tidak dirender. CommonMark mensyaratkan spasi setelah tanda pagar. #Title adalah teks biasa; # Title adalah heading.
Baris menyatu menjadi satu paragraf. Satu pemisah baris di dalam paragraf diperlakukan sebagai spasi. Sisakan satu baris kosong untuk memulai paragraf baru, atau akhiri baris dengan dua spasi atau backslash untuk pemisah baris paksa. (Komentar GitHub memperlakukan pemisah baris tunggal secara berbeda dari file README, yang menjadi sumber kebingungan yang umum.)
Daftar atau blok kode terputus sebelum waktunya. Konten yang termasuk dalam item daftar harus diindentasi agar sejajar dengan teks item tersebut. Untuk kode di dalam daftar, indentasi seluruh blok berpagar:
1. Install the package:
```bash
npm install example
```
2. Run it.
Tabel tidak dirender. Tabel GFM membutuhkan baris header, baris pemisah dengan minimal tiga tanda hubung per kolom, dan biasanya satu baris kosong sebelumnya. Gunakan titik dua pada pemisah (:---, :---:, ---:) untuk meratakan kolom.
Pemformatan yang tidak diinginkan. Karakter seperti *, _, dan # dapat memicu pemformatan. Escape karakter itu dengan backslash, misalnya \*not italic\*, atau bungkus dengan backtick.
Tips dan praktik terbaik
- Selalu tambahkan bahasa setelah backtick pembuka agar blok kode mendapat syntax highlighting di tempat yang mendukungnya.
- Tulis alt text yang bermakna untuk gambar; teks itu dipakai oleh pembaca layar dan ditampilkan saat gambar gagal dimuat.
- Gunakan satu kalimat per baris pada dokumen panjang; Markdown menyatukannya menjadi paragraf, dan diff menjadi jauh lebih bersih.
- Tempel contoh JSON atau YAML ke JSON Formatter & Validator atau YAML Formatter & Validator terlebih dahulu, agar blok kode di dokumentasi Anda valid dan rapi.
- Jika Anda menempelkan HTML yang dihasilkan ke halaman web, jalankan lewat HTML Formatter untuk mengindentasinya dengan rapi.
Pertanyaan yang sering diajukan
Apa perbedaan antara Markdown dan GitHub-flavoured Markdown?
GFM adalah superset Markdown CommonMark yang didefinisikan oleh GitHub. GFM menambahkan tabel, daftar tugas, teks dicoret, autolink yang diperluas, dan beberapa pembatasan pada HTML mentah. Sebagian besar README yang ditulis untuk GitHub dirender dengan cara yang sama di sini.
Bisakah saya memakai HTML di dalam Markdown?
Bisa, Markdown mengizinkan HTML inline. Demi keamanan, pratinjau menyanitasi keluarannya, sehingga tag seperti <script>, atribut event handler seperti onclick, dan tautan javascript: dihapus.
Mengapa Markdown saya terlihat berbeda di situs lain?
Platform memakai varian Markdown yang berbeda dan stylesheet mereka sendiri. Sintaks inti (heading, penekanan, daftar, tautan, kode) konsisten, tetapi tabel, pemisah baris, dan ekstensi seperti catatan kaki atau matematika berbeda antarrenderer.
Bagaimana cara mengonversi Markdown ke HTML?
Tulis atau tempel Markdown Anda, periksa pratinjaunya, lalu klik Salin HTML. Keluarannya adalah HTML semantik biasa (heading, paragraf, daftar, tabel) tanpa gaya, sehingga mengikuti CSS halaman tempat Anda menempelkannya.
Diperbarui