Apakah Pratonton Markdown?
Markdown ialah sintaks pemformatan ringan di sebalik README, catatan blog, mesej sembang, dokumentasi, dan pelbagai tempat lain di mana anda mahukan pemformatan yang mudah dan mudah dibaca tanpa menulis HTML mentah. Kerana Markdown adalah teks biasa, ia mudah ditulis di mana-mana sahaja — tetapi ia juga mudah tersilap sedikit sintaks tanpa disedari sehingga anda sudah menerbitkannya.
Pratonton ini memaparkan Markdown anda semasa anda menaip, bersebelahan dengan sumber, supaya anda boleh mengesan kesilapan format serta-merta — ruang yang hilang selepas #, pagar kod yang tidak ditutup, atau senarai yang tidak dipisahkan daripada perenggan di atasnya — sebelum anda commit README, terbitkan catatan, atau hantar mesej berformat.
Bila Menggunakan Kalkulator Ini
- Menulis README GitHub atau GitLab dan ingin mengesahkan pemformatan sebelum commit
- Menggubal siaran Markdown untuk platform blog, dokumentasi laman web, atau wiki
- Memeriksa e-mel atau mesej chat Markdown dipaparkan dengan betul sebelum menghantar
- Mempelajari sintaks Markdown dengan bereksperimen dengan pelbagai pemformatan dan melihat hasil segera
- Menukar petikan Markdown pendek ke HTML untuk menampal ke CMS atau templat e-mel
- Menyahpih dokumen Markdown di mana sesetengah pemformatan tidak dipaparkan seperti yang dijangkakan
Langkah:
- Taip atau tampal Markdown anda ke dalam panel kiri.
- Perhatikan pratonton HTML yang dipaparkan dikemas kini serta-merta di sebelah kanan.
- Laraskan sintaks anda sehingga pratonton sepadan dengan apa yang anda maksudkan.
- Salin sumber Markdown anda yang telah siap sebaik sahaja anda berpuas hati dengan hasilnya.
Rumus
Kes Penggunaan
- Pratonton README GitHub atau GitLab sebelum commit
- Merangka mesej berformat untuk Slack, Discord, atau aplikasi sembang lain yang menyokong Markdown
- Menyemak format catatan blog atau dokumentasi sebelum diterbitkan
- Mempelajari sintaks Markdown dengan bereksperimen dan melihat hasil serta-merta
- Menukar dengan pantas serpihan Markdown pendek kepada HTML untuk ditampal di tempat lain
Faedah Utama
- Lihat Markdown anda dipaparkan serta-merta, bersebelahan dengan sumber
- Kesan kesilapan sintaks sebelum menerbitkan di mana-mana
- Berjalan sepenuhnya luar talian dalam pelayar anda — tiada apa dimuat naik
- Percuma, tiada pendaftaran, tiada had saiz fail untuk penggunaan biasa
Tips Pro
- Tambah baris kosong sebelum dan selepas senarai dan blok kod untuk pemaparan paling boleh dipercayai merentas pelbagai pengurai Markdown yang berbeza
- Gunakan asterisk berganda untuk tebal dan asterisk tunggal (atau garis bawah) untuk italic bagi mengelakkan kekaburan
- Pratonton dalam alat ini dahulu, kemudian semak platform sasaran (GitHub, Slack, dll.) kerana sesetengah menyokong sintaks tambahan seperti jadual
- Kekalkan tajuk secara berturutan (jangan langkau daripada # ke ###) untuk struktur dokumen dan kebolehcapaian yang lebih baik
Kesilapan Biasa
- Terlupa baris kosong yang diperlukan antara perenggan dan senarai yang mengikutinya
- Terlepas ruang selepas simbol # dalam tajuk, menghalangnya daripada dipaparkan
- Membiarkan pagar kod (```) tidak ditutup, yang menelan selebihnya dokumen sebagai kod
- Menggunakan asterisk tunggal untuk tebal dan bukannya asterisk berganda, menghasilkan italic sebaliknya
Istilah Utama
- CommonMark: Spesifikasi sintaks Markdown yang distandardkan, direka untuk mengurangkan ketidakkonsistenan
- GFM: GitHub-Flavored Markdown, dialek lanjutan yang menyokong jadual dan senarai tugas
- Pagar kod: Blok yang dibatasi oleh tiga backtick (```) digunakan untuk memformat kod berbilang baris
- Format sebaris: Format yang digunakan dalam satu baris, seperti *italic* atau `kod`, berbeza dengan elemen peringkat blok
Konsep Berkaitan
- Pemformat JSON:
- Penguji regex:
- Penjana kata laluan:
- Penukar warna:
- Pengekod/penterjemah URL:
Contoh
Menaip "## Hello
Ini adalah **tebal** dan ini adalah *italic*." dipaparkan sebagai tajuk peringkat 2 diikuti perenggan dengan teks tebal dan italic.
Mentafsir Hasil
Panel kiri menunjukkan teks sumber Markdown mentah anda, dan panel kanan memaparkannya sebagai HTML berformat dalam masa nyata. Setiap ketukan kekunci mengemas kini pratonton serta-merta, supaya anda dapat melihat kesan setiap elemen sintaks dengan segera.
Isu paparan yang biasa biasanya berpunca daripada jarak. Baris kosong diperlukan antara perenggan dan senarai yang mengikutinya untuk kebanyakan pemapar. Tajuk memerlukan ruang selepas simbol #. Pagar kod (```) perlu berada pada baris sendiri untuk mencetuskan paparan blok kod.
Pratonton ini merupakan anggaran yang hampir dengan rupa Markdown anda pada kebanyakan platform (GitHub, Slack, Discord, dll.), tetapi setiap platform mempunyai pemapar sendiri dengan variasi yang sedikit. Sentiasa lakukan semakan akhir pada platform sasaran untuk apa-apa yang melangkaui pemformatan asas.