Cara menggunakannya
- Taip Markdown dalam editor atau klik “Cuba contoh” untuk memuatkan dokumen dengan jadual dan senarai tugasan.
- Lihat pratonton dikemas kini semasa anda menaip. Tukar kepada “Sumber HTML” untuk melihat penanda yang dijana.
- Hidupkan atau matikan GitHub Flavored Markdown atau pemisah baris tunggal untuk disesuaikan dengan tempat teks akan diterbitkan.
- Salin HTML ke dalam CMS atau e-mel, atau muat turun hasilnya sebagai fail .html atau .md.
Cara ia berfungsi
Markdown ditukar dengan marked, penghurai sumber terbuka yang digunakan secara meluas yang mengikuti spesifikasi CommonMark dan, dengan pilihan GFM dihidupkan, GitHub Flavored Markdown: jadual pipe dengan penjajaran lajur, senarai tugas, ~~strikethrough~~ dan pautan automatik untuk URL mentah. Nota kaki, matematik dan rajah Mermaid bukan sebahagian daripada spesifikasi ini dan dipaparkan sebagai teks biasa.
Markdown mungkin mengandungi HTML mentah, dan HTML itu diteruskan tanpa diubah, seperti kebanyakan pemproses Markdown lakukan. Untuk memastikan anda selamat, pratonton tidak pernah disisipkan ke dalam halaman ini. Ia dipaparkan di dalam bingkai kotak pasir yang tidak dibenarkan menjalankan skrip, menghantar borang, membuka tetingkap timbul atau mengakses laman ini, dan dasar keselamatan kandungannya menyekat skrip, helaian gaya luaran, fon dan bingkai. Tag <script> atau atribut onclick dalam Markdown anda dipaparkan dalam sumber HTML tetapi tidak pernah dilaksanakan. Pautan dalam pratonton dipaparkan tetapi tidak dibuka; salin URL jika anda perlu mengikutinya.
Pratonton menggunakan helaian gaya neutral yang serupa dengan pemproses README biasa; laman web anda atau GitHub mungkin menggayakan HTML yang sama secara berbeza. HTML yang disalin ialah serpihan mentah tanpa gaya; fail .html yang dimuat turun menambah helaian gaya asas supaya kelihatan seperti pratonton. HTML yang dimuat turun atau disalin tidak dibersihkan, jadi jika ia mengandungi skrip, skrip itu akan dijalankan di mana sahaja anda menampalnya atau membukanya.
Contoh
Menyemak README sebelum push
Tampal README.md untuk memastikan lajur jadual sejajar, senarai tugas dipaparkan sebagai kotak semak dan blok kod dipagari dengan betul, sebelum fail dihantar ke GitHub.
Menulis untuk CMS yang menerima HTML
Tulis draf catatan blog dalam Markdown, kemudian tekan “Salin HTML” dan tampal penanda <h2>, <p> dan <ul> ke dalam editor HTML CMS.
Pemisah baris gaya sembang
Teks daripada aplikasi sembang mempunyai baris yang dipisahkan oleh pemisah baris tunggal. Menghidupkan “Anggap pemisah baris tunggal sebagai <br>” mengekalkan baris tersebut berasingan dan bukannya menggabungkannya menjadi satu perenggan.
Soalan Lazim
Adakah selamat untuk menampal Markdown daripada sumber yang tidak diketahui?
Ya, untuk pratonton. HTML yang dihasilkan dipaparkan dalam bingkai kotak pasir dengan skrip dimatikan, jadi walaupun terdapat tag <script> atau pengendali peristiwa dalam teks, ia tidak melakukan apa-apa di sini. Berhati-hati di mana anda menampal HTML yang dieksport, kerana ia tidak dibersihkan.
Mengapa imej saya tidak muncul?
Imej dari laman web lain disekat secara lalai supaya pratonton tidak membuat sebarang permintaan rangkaian. Hidupkan “Muat imej dari laman web lain” untuk memaparkannya. Laluan relatif seperti ./docs/screenshot.png tidak boleh berfungsi kerana fail tersebut tiada di sini.
Adakah ia menyokong nota kaki, matematik atau gambar rajah?
Tidak. Ia menyokong CommonMark dan GitHub Flavored Markdown (jadual, senarai tugasan, teks coret, pautan automatik). Nota kaki, matematik LaTeX dan gambar rajah Mermaid ialah sambungan yang dibiarkan sebagai teks biasa oleh pratonton ini.
Mengapa pemisah baris tunggal tidak memulakan baris baharu?
Dalam Markdown standard, satu pemisah baris dalam perenggan dianggap sebagai ruang. Akhiri baris dengan dua ruang, biarkan satu baris kosong, atau hidupkan “Anggap pemisah baris tunggal sebagai <br>”.
Privasi
Markdown ditukar dalam pelayar anda dan tidak dimuat naik atau disimpan. Pratonton tidak memuatkan apa-apa daripada internet melainkan anda membenarkan imej dari laman web lain; kemudian imej tersebut diminta terus daripada hos mereka.