Panduan Markdown

Apa itu Markdown?

Markdown adalah bahasa markup ringan yang dapat Anda gunakan untuk menambahkan elemen pemformatan pada dokumen teks biasa. Markdown memungkinkan Anda membuat teks berformat menggunakan sintaks yang sederhana dan mudah dibaca yang dapat dikonversi ke HTML dan format lainnya.

Anggap Markdown sebagai cara untuk menulis dokumen berformat tanpa perlu pengolah kata yang kompleks. Anda cukup menambahkan karakter khusus ke teks biasa untuk menunjukkan format seperti tebal, miring, atau kode.

Mengapa Menggunakan Markdown?

Markdown sangat sederhana dan mudah dipelajari. Anda dapat menguasai dasar-dasarnya hanya dalam 10 menit. Simbol pemformatannya intuitif - tanda bintang untuk penekanan, hash untuk judul. Anda tinggal mengetik dan menambahkan simbol sederhana untuk memformat teks Anda.

Markdown bekerja di platform mana pun dan editor teks apa pun. Karena file-filenya berupa teks biasa, mereka akan selalu dapat dibaca, bahkan puluhan tahun dari sekarang. File-filenya ringan dan dimuat dengan cepat.

Markdown memiliki dukungan luas di berbagai platform. GitHub, Reddit, Discord, dan Slack semuanya menggunakan Markdown. Aplikasi populer seperti Obsidian, Notion, dan VS Code mendukungnya secara native. Ini membuatnya sempurna untuk dokumentasi, pencatatan, dan konten web.

Markdown bekerja sempurna dengan sistem kontrol versi seperti Git. Anda dapat fokus pada konten tanpa gangguan pemformatan. Kolaborasi tim menjadi lebih mudah karena semua orang dapat mengedit file tanpa perangkat lunak khusus.

Sejarah Perkembangan Markdown

Awal Mula: Vanilla Markdown (2004)

Markdown awalnya dibuat oleh John Gruber pada tahun 2004, dengan masukan signifikan dari Aaron Swartz. Gruber merancangnya sebagai cara sederhana untuk menulis menggunakan format teks biasa yang mudah dibaca dan mudah ditulis yang dapat dikonversi ke HTML yang valid secara struktural. Inilah "inti" yang awalnya dirancang dan diimplementasikan John Gruber, berisi sintaks pemformatan paling dasar - yang kita sebut "rasa vanilla dasar".

Sintaks Dasar (Vanilla Markdown termasuk):

  • •
    Header: Gunakan simbol # (# Header)

  • •
    Penekanan:

  • •
    Miring: Gunakan * atau _ untuk membungkus teks (*miring* atau _miring_)
  • •
    Tebal: Gunakan ** atau __ untuk membungkus teks (**tebal** atau __tebal__)

  • •
    Daftar:

  • •
    Daftar tidak berurutan: Gunakan *, -, atau + (- item)
  • •
    Daftar berurutan: Gunakan angka dengan titik (1. item)
  • •
    Tautan: Gunakan [teks tautan](alamat tautan)
  • •
    Gambar: Gunakan ![deskripsi gambar](alamat gambar)

  • •
    Blok kode: Indent dengan spasi (biasanya 4 spasi atau 1 Tab)

  • •
    Blockquote: Gunakan simbol > (> Ini adalah kutipan)
  • •
    Garis horizontal: Gunakan --- atau ***

Masalah: Implementasi yang Tidak Konsisten

Namun, Vanilla Markdown tidak memiliki spesifikasi formal yang ketat. Ini menyebabkan perilaku yang tidak konsisten di berbagai parser Markdown ketika menangani kasus tepi.

Penanganan spasi: Misalnya, dalam item daftar, berapa banyak spasi indentasi yang dihitung sebagai sub-daftar? Apakah 2 spasi, 3 spasi, atau 4 spasi? Parser yang berbeda mungkin memiliki penilaian yang berbeda.

Pemrosesan jeda baris: Dalam situasi tertentu, apakah jeda baris biasa(\n) harus diparsing sebagai tag <br> (jeda baris), atau haruskah diperlakukan sebagai spasi dalam teks? Ini juga bisa bervariasi tergantung pada parser.

Penggunaan HTML campuran: Markdown memungkinkan HTML tertanam. Namun, dalam beberapa struktur HTML yang kompleks, bagaimana parser Markdown menangani sintaks Markdown di dalamnya juga menyajikan area yang ambigu.

Solusi: CommonMark (2014)

Pada September 2014, CommonMark diperkenalkan untuk menyelesaikan masalah inkonsistensi ini. Dipimpin oleh John MacFarlane, ini menyediakan spesifikasi yang ketat untuk Markdown.

CommonMark menyediakan spesifikasi yang tepat di mana setiap kasus tepi didefinisikan dengan jelas. Ini mencakup rangkaian tes komprehensif dengan lebih dari 600 kasus tes untuk memastikan konsistensi di seluruh implementasi. Spesifikasi menyediakan implementasi referensi yang berfungsi sebagai standar untuk parser lain. Ini mempertahankan kompatibilitas mundur dengan sebagian besar dokumen Markdown yang ada sambil memastikan parsing yang tidak ambigu di mana input yang sama selalu menghasilkan output yang sama di semua parser yang sesuai.

Rasa yang Diperluas dan Fitur Tambahan

Karena pengguna memiliki kebutuhan yang berbeda, berbagai rasa Markdown yang diperluas muncul untuk memenuhi persyaratan spesifik.

GitHub Flavored Markdown (GFM) Sintaks Tambahan:

  • •
    Tabel: Gunakan sintaks pipe untuk membuat tabel
  | Header 1 | Header 2 | Header 3 |
  |----------|----------|----------|
  | Cell 1   | Cell 2   | Cell 3   |
  | Cell 4   | Cell 5   | Cell 6   |
  • •
    Strikethrough: Gunakan ~~ untuk membungkus teks (~~teks yang dihapus~~)

  • •
    Daftar Tugas: Buat checkbox interaktif

  - [x] Tugas selesai
  - [ ] Tugas belum selesai
  • •
    Blok Kode Berpagar: Gunakan triple backtick dengan spesifikasi bahasa
  ```javascript
  function hello() {
    console.log("Hello World!");
  }
  ```
  • •
    Tautan Otomatis: URL dan alamat email menjadi dapat diklik secara otomatis

Ekstensi Populer Lainnya:

  • •
    Footnote: Gunakan sintaks [^1] untuk penulisan akademik
  Ini adalah kalimat dengan footnote[^1].
  [^1]: Ini adalah konten footnote.

Hasil: Ini adalah kalimat dengan footnote¹.

  • •
    Ekspresi Matematika: Gunakan $E=mc^2$ untuk dokumen ilmiah
  • •
    Shortcut Emoji: Gunakan :smile: menjadi 😊

  • •
    Daftar Definisi: Untuk glosarium dan dokumentasi teknis

  Istilah 1
  : Definisi untuk istilah 1
  
  Istilah 2
  : Definisi untuk istilah 2
  : Definisi lain untuk istilah 2

Hasil: Membuat daftar berformat dengan istilah yang disorot dan definisi yang menjorok

Bagaimana Cara Kerjanya?

Markdown mengikuti alur kerja tiga langkah yang sederhana:

Langkah 1: Buat File Markdown

Pertama, Anda membuat file teks biasa dengan ekstensi .md atau .markdown menggunakan editor teks apa pun. Anda menulis konten menggunakan simbol pemformatan sederhana:

Langkah 2: Proses dengan Tools Markdown

File .md Anda kemudian diproses oleh tools konversi Markdown atau processor. Tools ini membaca file Markdown Anda dan mengonversinya ke format output yang diinginkan.

Langkah 3: Output ke Berbagai Format

Processor Markdown dapat mengonversi file Anda ke berbagai format:

Untuk Tampilan Web:

  • •
    Mengonversi ke HTML untuk website, blog, dan aplikasi web

  • •
    Menampilkan konten berformat di browser dengan styling yang tepat

Untuk Dokumen:

  • •
    Mengonversi ke PDF untuk dokumen yang dapat dicetak dan laporan

  • •
    Menghasilkan dokumen Word (.docx) untuk penggunaan kantor
  • •
    Membuat LaTeX untuk paper akademik dan publikasi

Untuk Penerbitan:

  • •
    Menghasilkan eBook (format EPUB)

  • •
    Membuat slide presentasi
  • •
    Menghasilkan website dokumentasi

Alur kerja ini berarti Anda menulis sekali dalam Markdown, kemudian menggunakan tools yang berbeda untuk mengonversi konten Anda ke format apa pun yang Anda butuhkan - baik itu menampilkan di website, mencetak sebagai PDF, atau berbagi sebagai dokumen.

Sumber Daya Tambahan

Dokumentasi Penting

  • •
    Dokumentasi Markdown John Gruber :Panduan asli yang ditulis oleh pencipta Markdown. Bacaan penting untuk memahami filosofi dan sintaks dasar.

  • •
    Wikipedia - Markdown :Tinjauan komprehensif tentang sejarah Markdown, variasi, dan detail teknis.

  • •
    Panduan Markdown :Panduan komprehensif dan ramah pemula dengan contoh dan praktik terbaik untuk semua tingkat keahlian.