預覽結果顯示在這裡
工具說明
關於 Markdown 預覽器
Markdown Preview 會把 Markdown 原文即時渲染成可讀預覽,方便檢查標題、列表、連結、引用、表格與程式碼區塊。
適合在提交 README、文件片段、Issue 或部落格草稿前快速確認排版。
如何使用 Markdown Preview
- 貼上 Markdown 原文。
- 使用範例確認 GFM 表格、程式碼區塊與連結的渲染效果。
- 檢查標題層級、列表縮排與連結是否符合預期。
常見使用場景
- 提交 README 前確認程式碼區塊語言與表格對齊。
- 寫 GitHub Issue 或發布說明前預覽結構。
- 把 API 文件片段貼進來檢查標題與列表巢狀。
Markdown 語法與常見排版問題
Markdown 看似簡單,但空行、縮排與反引號數量都會影響渲染。GitHub Flavored Markdown 還支援表格、任務清單與圍欄程式碼區塊。
- 標題使用 #,頁面裡建議保持層級遞進。
- 列表巢狀依賴縮排,混用空格與 Tab 容易錯位。
- 程式碼區塊用三個反引號包住,並可標註語言。
- 連結文字應可讀,不要只寫「點這裡」。
Markdown 預覽常見問題
- 支援 GitHub Flavored Markdown 嗎?
- 常見 GFM 寫法如表格、程式碼區塊與任務列表可用於預覽,但最終效果仍以目標平台為準。
- 為什麼列表沒有巢狀成功?
- 通常是縮排或空行問題。子列表需要比父層多縮排,並保持符號風格一致。
- 內容會上傳嗎?
- 不會。Markdown 渲染在瀏覽器本機執行,不會上傳到 wetool.site。
Markdown Preview 與正式發布
預覽能發現多數排版問題,但 GitHub、npm、論壇或 CMS 可能有自己的 Markdown 擴充與安全過濾,發布前仍要在目標平台複核。
Markdown 方言差異對照
預覽工具能幫你找出結構問題,但不同平台的 Markdown 方言並不完全一致。
- CommonMark 涵蓋標題、段落、清單、引言與程式碼區塊等基礎語法。
- GitHub Flavored Markdown 增加表格、任務清單、刪除線與自動連結等常見擴充。
- Blog、CMS 與文件站可能額外支援 front matter、標題錨點、註腳或數學公式。
安全渲染與發布邊界
Markdown 預覽不是正式發布環境,尤其要注意 HTML、圖片、外部連結與平台過濾規則。
- 不要把不受信任的 Markdown 當成安全的 HTML;目標平台通常會淨化原始 HTML。
- 外部圖片和 links 在正式發布後可能暴露請求來源、Token 參數或內部位址。
- 發布 README、npm 文件或 CMS 頁面前,仍要在目標平台複核最終渲染結果。