Markdown: susun makna sebelum menghias tampilan
Markdown berguna untuk catatan dan dokumentasi karena sumbernya tetap dapat dibaca sebagai teks. Nilainya ada pada pemisahan judul, paragraf, dan daftar, bukan banyaknya tanda format.
Judul bukan sekadar ukuran huruf
Mulai dari topik dokumen, lalu tempatkan bagian di tingkat judul yang lebih rendah. # dan ## yang diikuti spasi menunjukkan tingkat berbeda; menjadikan setiap baris judul utama menghilangkan hierarki itu.
Pakai daftar untuk butir terpisah dan paragraf untuk menjelaskan hubungannya. Format mendukung kalimat yang jelas, bukan menggantikannya.
Referensi: CommonMark 0.31.2 — Structured text, headings and rendering differences
Pratinjau tidak mewakili semua tempat penerbitan
Ekstensi Markdown berbeda antar-sistem. Tabel yang bekerja di satu editor belum tentu tampil sama di tempat lain; periksa dokumen di tempat pembaca akan menggunakannya.
ToolRoof menampilkan dan mengekspor HTML, tetapi tidak menjalankan HTML mentah dari masukan. Gambar eksternal diganti deskripsi dan tautan tidak aktif dalam pratinjau. Ini bukan penyalin halaman web lengkap.
Referensi: CommonMark 0.31.2 — Structured text, headings and rendering differences
Simpan sumber bersama hasilnya
Sumber Markdown membantu membandingkan revisi. HTML berguna untuk penyajian, tetapi konversi balik tidak harus menghasilkan sumber yang persis sama.
Tinjau isi dan tautan sebelum membagikan hasil. Pratinjau tidak membuktikan kebenaran informasi, keamanan situs tertaut, atau izin menggunakan karya orang lain.
Contoh: catatan rapat singkat
Tulis # Rencana mingguan, lalu ## Prioritas, kemudian - Tinjau ringkasan dan - Kirim draf pada baris terpisah. Hasilnya judul utama, subjudul, dan daftar 2 butir, bukan 4 paragraf serupa.
#Rencana mingguan tanpa spasi bukan judul ATX. Kode di antara backtick tetap berupa teks: tampil dalam pratinjau bukan berarti dijalankan atau terbukti benar.