Panduan alat
Tentang Pratinjau Markdown
Markdown Preview merender Markdown source menjadi preview yang mudah dibaca untuk memeriksa headings, lists, links, blockquotes, tables, dan code blocks.
Gunakan sebelum mengirim README, snippet dokumentasi, issue, atau draft blog.
Cara memakai Markdown Preview
- Tempel Markdown source.
- Gunakan sample untuk memeriksa GFM tables, fenced code blocks, dan links.
- Periksa heading hierarchy, list indentation, dan link rendering.
Kapan dipakai
- Cek language code block dan alignment table README sebelum commit.
- Preview GitHub issue atau release note sebelum posting.
- Inspect snippet dokumentasi API untuk headings dan nested lists.
Markdown syntax dan formatting traps
Markdown ringan, tetapi blank lines, indentation, dan jumlah backticks memengaruhi rendering. GitHub Flavored Markdown menambah tables, task lists, dan fenced code blocks.
- Headings memakai # dan sebaiknya mengikuti logical hierarchy.
- Nested lists bergantung pada indentation; campuran tabs dan spasi sering merusak layout.
- Fenced code blocks memakai triple backticks dan bisa menyertakan language name.
- Link teks harus deskriptif, bukan hanya “click here”.
Pertanyaan umum tentang Pratinjau Markdown
- Apakah mendukung GitHub Flavored Markdown?
- Common GFM features seperti tables, fenced code blocks, dan task lists bisa dipreview, tetapi rendering akhir tergantung target platform.
- Mengapa nested list gagal?
- Biasanya indentation atau blank lines. Indent child list items lebih dalam dari parent dan jaga marker style konsisten.
- Apakah konten saya diunggah?
- Tidak. Markdown rendering berjalan lokal di peramban dan tidak diunggah ke wetool.site.
Markdown Preview vs publikasi
Preview menangkap banyak formatting issues, tetapi GitHub, npm, forums, dan CMS bisa memakai Markdown extensions dan sanitizers berbeda. Cek ulang di target platform sebelum publish.
Perbandingan Markdown dialect
Preview alat membantu menemukan structure issues, tetapi Markdown dialect berbeda antar platform.
- CommonMark mencakup baseline syntax seperti headings, paragraphs, lists, blockquotes, dan code blocks.
- GitHub Flavored Markdown menambah common extensions seperti tables, task lists, strikethrough, dan autolinks.
- Blogs, CMS, dan documentation sites dapat menambah front matter, heading anchors, footnotes, atau math formulas.
Safe rendering dan batas publishing
Markdown preview bukan final publishing environment, terutama untuk HTML, images, external links, dan platform filters.
- Jangan perlakukan untrusted Markdown sebagai safe HTML; target platforms biasanya sanitize raw HTML.
- External images dan links dapat mengekspos permintaan sources, token parameters, atau internal addresses setelah publishing.
- Sebelum publish README, npm docs, atau CMS pages, cek final rendering di target platform.