Contekan Markdown

Langkah 1 / 3 33%

Pilih topik Markdown

Mulai dari satu kelompok contoh, lalu buka referensi lengkap.

Sintaks Markdown penting dikelompokkan berdasarkan topik dan ditampilkan sebagai sumber siap salin beserta hasil parser yang sebenarnya. Cakupannya meliputi dasar CommonMark (judul, daftar, penekanan, tautan, gambar, dan blok kode berpagar) serta ekstensi GitHub Flavored Markdown (tabel, daftar tugas, coretan, dan tautan otomatis untuk URL biasa). Simpan halaman ini saat bekerja dengan GitHub, GitLab, Obsidian, dan pembuat situs statis.

Cara menggunakan contekan ini

  1. 1

    Telusuri berdasarkan kategori

    Lompat ke judul, daftar, kode, tautan, tabel, atau ekstensi GFM.

  2. 2

    Bandingkan sumber dan hasil

    Setiap contoh menampilkan Markdown mentah di samping hasil parser GFM yang sebenarnya.

  3. 3

    Salin cuplikan

    Ketuk salin untuk mengambil sumber dari contoh mana pun.

  4. 4

    Periksa label sintaks

    Setiap contoh diberi label CommonMark atau GitHub Flavored Markdown (GFM).

Judul

# Judul H1
## Bagian H2
### Subbagian H3

Gunakan format ATX (#) alih-alih Setext (=== di bawah teks). Semua parser mendukung keduanya, tetapi ATX lebih mudah dibaca dalam diff.

Penekanan

*miring* atau _miring_, **tebal** atau __tebal__, ***tebal miring***. GFM menambahkan ~~coretan~~.

Daftar

Daftar tak berurutan menggunakan -, *, atau + (pilih salah satu dan gunakan secara konsisten):

- Pertama
- Kedua
  - Bersarang (dua spasi)

Daftar berurutan dinomori ulang secara otomatis:

1. Item
1. Item
1. Item

Kode

Sebaris: `code`. Blok berpagar dengan tag bahasa opsional:

```python
def hello(name):
    return f"Halo, {name}"
```

Beri indentasi empat spasi untuk blok kode jika Anda lebih menyukai sintaks lama.

Tautan dan gambar

[Teks tautan](https://example.com)
[Tautan dengan judul](https://example.com "Petunjuk")
![Teks alternatif](/path/to/image.png)

Gaya referensi menjaga URL panjang tetap di luar paragraf:

Lihat [dokumentasi][1].

[1]: https://example.com/docs

Tabel (GFM)

| Col A | Col B |
|-------|------:|
| a     |     1 |
| b     |    22 |

Perataan menggunakan titik dua pada baris pemisah: :--- kiri, :---: tengah, ---: kanan.

Daftar tugas (GFM)

- [x] Selesai
- [ ] Perlu dikerjakan

Kesalahan umum

  • Dua spasi di akhir baris menyisipkan pemutus baris di dalam paragraf. Satu spasi hanya menyambung baris.
  • Baris kosong wajib ada sebelum sebagian besar elemen blok (judul, daftar, blok kode).
  • Jangan beri indentasi penanda daftar dengan tab jika renderer Anda mengharapkan spasi; beri indentasi dengan dua atau empat spasi.
  • Escape dengan garis miring terbalik untuk tanda baca harfiah: \*bukan miring\*.
  • Tanda kutip pintar berbeda-beda tergantung renderer. GitHub membiarkannya apa adanya; Pandoc mengonversinya.

Pertanyaan yang Sering Diajukan

CommonMark menetapkan inti portabel, termasuk judul, daftar, tautan, serta blok kode berpagar dengan keterangan opsional. GFM menambahkan tabel, daftar tugas, coretan, dan tautan otomatis untuk URL biasa. Editor lain mungkin hanya mendukung sebagian atau menambahkan ekstensi sendiri.

Markdown memperlakukan satu baris baru sebagai spasi. Untuk <br>, akhiri baris dengan dua spasi, atau gunakan \ di akhir baris pada GFM.

Ya, pada sebagian besar parser, tag HTML tingkat blok diteruskan langsung. Beberapa renderer menyanitasinya (GitHub menghapus skrip inline dan atribut event).

CommonMark tidak memiliki sintaks daftar isi bawaan. GitHub membuat anchor judul dan menampilkan kerangka untuk berkas dengan beberapa judul. Platform lain memiliki aturan sendiri: MkDocs dapat memakai [TOC] saat ekstensi terkait aktif, sedangkan Docusaurus menyusun daftar isi halaman dari judul.

Aturan CommonMark dan GFM berlaku. Namun, Obsidian menambahkan tautan wiki ([[Nama halaman]]), callout, dan blok tersemat yang hanya tersedia di Obsidian, elemen-elemen ini tidak termasuk dalam contekan ini.

Alat Terkait