Pratonton Markdown
Tulis Markdown di sebelah kiri dan lihat pratonton langsung yang selamat di sebelah kanan.
Tulis Markdown
Gunakan sintaks Markdown biasa untuk menyediakan heading, senarai, pautan, petikan dan blok kod berpagar.
Rujukan sintaks ringkas
Gunakan corak biasa ini semasa menguji format Markdown.
Heading
# Nota Keluaran
Gunakan satu hingga enam simbol # diikuti dengan ruang.
Tebal
**Kemas kini penting**
Balut teks dengan asterisk berganda untuk penekanan kuat.
Senarai
- Item satu
Gunakan sempang untuk senarai tidak tertib atau 1. untuk senarai tertib.
Pautan
[ToolSG](https://www.toolsg.com)
Tanda kurung siku memegang label dan tanda kurung memegang URL.
Petikan
> Semak status penerapan terkini.
Awalan baris dengan > untuk petikan blok atau nota seruan.
Pagar kod
```bash
Balut petikan berbilang baris dengan tiga backtick.
Pratonton langsung
Pratonton dikemas kini secara setempat dalam pelayar anda dan HTML mentah di-escape untuk paparan yang lebih selamat.
Perkataan
0
Aksara
0
Baris
0
Masa bacaan
0 min
Sintaks yang disokong termasuk heading, penekanan, pautan, petikan, senarai, kod sebaris, dan blok kod berpagar.
Tentang Alat Pratonton Markdown Ini
Pratonton Markdown membolehkan anda menulis teks biasa dengan penanda format ringan dan segera melihat bagaimana kandungan itu kelihatan apabila dipaparkan. Ini penting kerana Markdown direka untuk kekal mudah dibaca dalam bentuk mentah sambil tetap menyokong heading, penekanan, senarai, pautan, petikan, dan blok kod. Apabila anda sedang merangka fail README, nota produk, dokumentasi dalaman, changelog, rangka blog, atau laporan isu, pratonton langsung mengurangkan tekaan dan membantu anda menangkap masalah format lebih awal.
Pratonton Markdown ini dibina untuk penyuntingan pantas berasaskan pelayar. Draf anda kekal pada peranti anda, pratonton dikemas kini semasa anda menaip, dan paparan sengaja meng-escape HTML mentah sebelum menggunakan peraturan Markdown yang disokong. Itu menjadikannya pilihan praktikal apabila anda mahu menguji struktur dan kebolehbacaan tanpa menghantar nota peribadi atau petikan kod ke pelayan.
Pratonton berguna lebih daripada sekadar kemasan visual. Ia membantu anda mengesahkan sama ada tahap heading konsisten, sama ada idea bersarang perlu menjadi senarai, sama ada pautan mudah diimbas, dan sama ada contoh kod dipisahkan dengan jelas daripada teks penjelasan. Ini amat penting untuk dokumentasi pembangun, nota serahan, wiki projek, siaran komuniti, dan artikel sokongan di mana susun atur menjejaskan kefahaman.
Gunakan halaman ini sebagai ruang kerja draf pantas, alat pengajaran untuk asas Markdown, atau langkah QA akhir sebelum menampal kandungan ke GitHub, GitLab, editor serasi Notion, penjana laman statik, atau alat lain yang menerima sintaks Markdown.
Cara Menggunakan
- Tampal atau taip Markdown ke dalam editor di sebelah kiri halaman.
- Tonton pratonton langsung dikemas kini di sebelah kanan apabila heading, senarai, petikan, kod sebaris, dan blok kod berpagar dipaparkan.
- Gunakan Muat contoh jika anda mahukan contoh pantas yang menunjukkan corak Markdown biasa.
- Semak kad perkataan, aksara, baris, dan masa bacaan untuk memahami saiz draf semasa.
- Salin Markdown kembali ke papan klip anda apabila anda sedia menampalnya ke dokumentasi, repositori, atau CMS.
Jika pratonton kelihatan salah, semak butiran sintaks kecil terlebih dahulu. Ruang yang hilang selepas simbol hash, inden tidak konsisten, atau pagar kod yang tidak ditutup ialah punca biasa isu format. Oleh sebab pratonton dikemas kini serta-merta, mudah untuk membetulkan kesilapan itu semasa sumber masih segar dalam minda.
Istilah & Konsep Utama
Markdown
Markdown ialah bahasa penanda ringan yang menggunakan simbol teks biasa untuk mewakili format. Ia popular kerana mudah alih, mesra kawalan versi, dan mudah dibaca tanpa editor khusus.
Pratonton langsung
Pratonton langsung memaparkan hasil berformat semasa anda menyunting sumber. Ia membantu anda menangkap isu struktur dengan pantas berbanding bertukar antara mod sunting dan mod terbit.
Blok kod berpagar
Blok kod berpagar menggunakan tiga backtick untuk membungkus kod berbilang baris atau contoh arahan. Ia memisahkan kandungan teknikal daripada perenggan biasa dan meningkatkan kebolehbacaan.
Kod sebaris
Kod sebaris menggunakan backtick tunggal di sekeliling arahan pendek, nama fail, pembolehubah, atau petikan. Ia berguna apabila anda perlu menyebut kod dalam ayat tanpa memecahkan aliran.
Escape dan sanitasi
Pratonton ini meng-escape HTML mentah sebelum memaparkan corak Markdown yang disokong. Itu menjadikan pratonton lebih selamat dengan menghalang penanda atau skrip sewenang-wenangnya daripada dilaksanakan dalam pelayar.
Kegunaan Biasa
- Merangka fail README repositori sebelum menyerahkannya.
- Mempratonton templat isu, penerangan pull request, dan nota keluaran.
- Menyediakan dokumentasi dalaman, panduan onboarding, dan runbook.
- Menguji bagaimana pautan, senarai berbulet, dan pagar kod akan kelihatan dalam portal pembangun.
- Mengajar asas Markdown kepada rakan sepasukan, pelajar, atau penyumbang bukan teknikal.
- Menyemak dokumentasi yang disalin daripada alat sembang atau nota teks biasa sebelum diterbitkan.
Contoh
Contoh: Pengenalan README
Ringkasan projek pendek sering lebih mudah dibaca apabila baris pertama menjadi heading tahap satu dan langkah persediaan utama menjadi senarai bernombor. Mempratonton struktur itu membantu anda menjadikan halaman mudah diimbas sebelum menolaknya ke repositori.
Contoh: Artikel sokongan
Jika anda menulis nota penyelesaian masalah, petikan blok boleh menonjolkan amaran penting manakala blok kod berpagar mengekalkan arahan terminal berasingan daripada penjelasan sekeliling. Pratonton menjadikan pemisahan itu jelas.
Contoh: Entri changelog
Ringkasan keluaran sering mendapat manfaat daripada heading ringkas, senarai berbulet, dan kod sebaris di sekeliling nombor versi atau arahan. Melihat hasil yang dipaparkan membantu anda mengimbangkan butiran dan kebolehbacaan.
Nota Penting
- Alat ini menumpukan pada sintaks Markdown biasa yang digunakan dalam aliran kerja dokumentasi dan sengaja tidak memaparkan HTML mentah.
- Output tepat mungkin masih berbeza sedikit daripada GitHub, GitLab, atau CMS tertentu kerana setiap platform boleh menyokong sambungan sintaks tambahan.
- Pautan disanitasi sebelum dipaparkan, jadi skema URL yang tidak disokong atau tidak selamat ditunjukkan sebagai teks biasa berbanding pautan yang boleh diklik.
- Dokumen besar masih boleh dipratonton di sini, tetapi jadual yang sangat kompleks atau sambungan khusus platform mungkin memerlukan ujian dalam platform sasaran juga.
- Draf anda kekal dalam pelayar melainkan anda memilih untuk menyalinnya ke tempat lain.
Soalan Lazim
Jawapan pantas ini menjelaskan apa yang disokong oleh Pratonton Markdown ini dan bila anda masih perlu mengesahkan format dalam platform penerbitan akhir anda.
Apakah pratonton Markdown?
Pratonton Markdown memaparkan output berformat daripada teks sumber Markdown semasa anda menyunting. Ia membantu anda menangkap isu struktur dan kebolehbacaan sebelum anda menerbitkan atau menyerahkan kandungan akhir.
Adakah alat ini menghantar Markdown saya ke pelayan?
Tidak. Alat ini memaparkan pratonton dalam pelayar anda supaya draf kekal pada peranti anda melainkan anda memilih untuk menyalinnya ke tempat lain.
Bolehkah saya mempratonton blok kod dengan tiga backtick?
Ya. Blok kod berpagar yang dibungkus dengan tiga backtick dipaparkan dalam bekas kod khusus supaya arahan dan petikan kekal mudah dibaca.
Adakah pratonton melaksanakan HTML mentah?
Tidak. HTML mentah di-escape sebelum peraturan Markdown yang disokong digunakan, yang menjadikan pratonton lebih selamat dan mengurangkan risiko pelaksanaan skrip dalam halaman.
Adakah ini akan kelihatan tepat seperti Markdown GitHub?
Tidak semestinya. Alat ini direka sekitar corak Markdown biasa, tetapi platform seperti GitHub mungkin menambah sambungan, gaya, atau peraturan penghuraian tambahan.
Bolehkah saya menggunakan ini untuk fail README dan penerangan pull request?
Ya. Ia sesuai untuk merangka fail README, laporan isu, nota keluaran, changelog, dan penerangan pull request sebelum anda menampalnya ke alat lain.
Mengapa sesetengah pautan tidak boleh diklik dalam pratonton?
Pautan dengan skema URL yang tidak disokong atau tidak selamat sengaja tidak dipaparkan sebagai sauh yang boleh diklik. Itu menjadikan pratonton lebih selamat dan mengelakkan output yang mengelirukan.
Adakah pratonton ini menyokong heading, senarai, petikan, dan kod sebaris?
Ya. Alat ini menyokong elemen struktur Markdown biasa seperti heading, senarai tertib dan tidak tertib, petikan blok, kod sebaris, penekanan, dan blok kod berpagar.