Baca fail dahulu, kemudian tentukan perkara yang hendak diubah
Mencari pemapar MD dalam talian untuk membaca README atau nota? Buka fail .md dan pilih Pratonton untuk paparan bacaan. Jika perlu mengubah kandungan, beralih ke Editor atau Pisah; sumber masih boleh diperiksa dan disimpan.
Gunakan pintasan papan kekunci untuk suntingan kerap, buka fail jika anda sudah mempunyai draf dan pilih sama ada mahu menyimpan draf setempat. Draf pelayar yang disimpan terikat pada profil pelayar ini; ia bukan sandaran awan.
Editor yang mengekalkan sumber dalam paparan
Baca fail MD tanpa menyunting
Gunakan pratonton sebagai pemapar fail MD untuk membaca tajuk, senarai, jadual dan kod. Panel sumber disembunyikan; beralih semula ke Editor tidak membuang teks anda.
Sisipkan unsur yang lebih rumit
Bina jadual asas, tambah persamaan sebaris atau paparan, sisipkan contoh Mermaid atau benamkan imej raster setempat. Kemudian edit sumber yang disisipkan secara terus.
Pratonton langsung Markdown semasa menulis
Pilih Pisah untuk melihat sumber dan dokumen yang dipaparkan bersebelahan. Perubahan muncul selepas jeda singkat semasa menaip, memudahkan semakan penjajaran jadual, blok kod dan formula yang disokong. Dokumen panjang mungkin memerlukan kemas kini pratonton secara manual.
Pilih cara anda bekerja
Gunakan mod Editor, Pratonton atau Pisah, aktifkan mod Fokus, dan laraskan tipografi serta zum dokumen. Muat turun Markdown apabila anda memerlukan salinan mudah alih.
Mulakan dengan dokumen yang benar-benar anda perlukan
README projek
Buka README untuk bacaan pantas, kemudian gunakan Pisah jika mahu menyemak arahan persediaan.
# Nama projek Penerangan ringkas tentang **fungsi projek ini**. ## Mula menggunakan ```bash npm ci ``` ## Langkah seterusnya - [ ] Tambah contoh yang berfungsi - [ ] Semak dokumentasi
- Perenggan pembuka yang jelas
- Arahan dalam blok kod
- Senarai semak yang boleh dilaksanakan
Nota keputusan dengan rajah
Simpan alasan dan carta alir dalam satu fail sumber.
# Aliran kerja semakan ```mermaid flowchart LR A[Draf] --> B[Semakan] B --> C[Penerbitan] ``` Penyemak memeriksa dakwaan sebelum dokumen dikongsi.
- Sintaks rajah sah
- Label mudah dibaca
- Teks menerangkan rajah
Buka, pratonton dan simpan dokumen
Buka fail atau tampal kandungannya
Pilih Buka fail untuk dokumen .md atau tampal Markdown ke dalam editor. Untuk README di GitHub, simpan fail mentah terlebih dahulu; memasukkan alamat web tidak akan mengimport dokumen.
Baca atau semak perubahan bersebelahan
Pilih Pratonton untuk membaca tanpa panel sumber. Untuk menyemak semula dokumen, gunakan Pisah supaya pratonton langsung kelihatan semasa anda mengedit. Bar alat membantu menambah tajuk, pautan, senarai dan jadual tanpa perlu menghafal semua sintaks.
Simpan salinan yang boleh terus disunting
Pilih Muat turun MD untuk menyimpan sumber pada peranti. HTML berguna untuk dokumen yang telah dipaparkan; gunakan alat PDF apabila memerlukan salinan bacaan untuk dikongsi. Simpanan draf pelayar adalah pilihan dan bukan pengganti fail yang disimpan.
Semak hasil sebelum berkongsi
| Kandungan | Perkara yang perlu dibuat | Perkara yang dijangka |
|---|---|---|
| Pemformatan tidak sengaja | Semak sumber yang dijana selepas menggunakan tindakan bar alat. | Teks tebal dan senarai kekal sebagai Markdown biasa dan boleh diubah secara manual. |
| Pemulihan draf | Aktifkan simpanan, edit draf kecil, muat semula dan pulihkannya. | Simpanan khusus pada peranti dan mungkin dipadam oleh tetapan pelayar. |
| Teks yang dijana AI | Sahkan fakta dan baiki blok kod rosak atau formula yang tidak disokong. | Pemformatan boleh meningkatkan kebolehbacaan; ia tidak membuktikan ketepatan fakta. |
Soalan tentang aliran kerja ini
Bolehkah saya menggunakan ini sebagai pemapar MD dalam talian tanpa menyunting?
Ya. Pilih Buka fail, pilih dokumen .md dan beralih ke Pratonton. Anda boleh membaca kandungan yang dipaparkan tanpa mengubah sumber. Apabila perlu mengedit, beralih semula ke Editor atau Pisah.
Bagaimanakah saya boleh melihat pratonton fail MD dalam talian semasa menulis?
Tampal sumber atau buka fail, kemudian pilih Pisah. Pratonton dikemas kini selepas jeda singkat semasa anda menaip. Jika pratonton automatik dijeda untuk dokumen panjang, pilih Kemas kini pratonton. Dokumen tidak perlu dimuat naik untuk suntingan atau pratonton.
Bolehkah saya menggunakannya tanpa mengetahui semua sintaks Markdown?
Bar alat menyisipkan sintaks lazim dan contoh memberikan titik permulaan. Kekalkan sumber yang kelihatan untuk mengetahui perubahan yang dibuat oleh setiap butang.
Di manakah draf disimpan?
Hanya dalam pelayar ini apabila simpanan setempat diaktifkan. Draf tidak disegerakkan antara peranti dan akan terpadam apabila storan pelayar dibersihkan. Muat turun MD untuk salinan yang tahan lama.
Apakah yang berlaku kepada dokumen yang sangat panjang?
Suntingan dan muat turun sumber masih tersedia. Pratonton automatik mungkin dijeda untuk memastikan editor responsif; kemas kini secara manual apabila anda mahu memeriksa hasilnya.
Adakah tag HTML disokong?
Editor menerima beberapa tag pemformatan tanpa atribut untuk garis bawah, superskrip, subskrip, kekunci papan kekunci dan serlahan. HTML mentah yang lain dipaparkan sebagai teks.
Bolehkah saya menggunakan formula dan rajah?
Editor memaparkan formula KaTeX dan blok kod Mermaid yang disokong. Kandungan tidak sah ditandakan supaya anda boleh membetulkan sumber sebelum mengeksport hasil paparan.
Cara alat ini mengendalikan dokumen anda
- Editor dan pratonton berjalan dalam pelayar anda.
- Simpanan draf setempat adalah pilihan dan boleh dinyahaktifkan atau dikosongkan.
- Muat turun PDF ialah operasi pelayan berasingan; Cetak setempat dan muat turun MD/HTML turut tersedia.
Rujukan formatBantuan CommonMarkSpesifikasi GitHub Flavored Markdown
Laporkan masalah yang boleh dihasilkan semulaNyatakan pelayar, tetapan yang dipilih dan contoh kecil tanpa maklumat sulit. Jangan e-mel dokumen peribadi.
