Markdown預覽

免費安全的Markdown HTML預覽工具。

在瀏覽器裡預覽 Markdown

左側寫 Markdown,右側即刻現出算繪的結果。標題、強調、連結、清單、引用、分隔線以及圍欄程式碼區塊,均在支援之列。

**要留意的是,Markdown 並無單一的官方規範。** 2004 年最初的寫法留下了不少未定之處,於是 GitHub、CommonMark 等各家在巢狀清單、換行、詞中底線一類的細處上並不一致——在一處看來無誤的文件,換個地方呈現便可能兩樣。尤其常被絆住的是換行:**多數處理系裡,一次換行並不會在段落內斷行**,須在行尾留兩個空格,或夾一個空行。

本工具在預覽之前會把原始 HTML 轉義,故而貼來的內容無從在此執行指令碼。

Markdown 預覽的用法

  1. 貼上或寫下 Markdown 在左側編輯器裡輸入,預覽會隨即更新。
  2. 查看算繪的結果 發布之前,先核對標題、清單、連結與程式碼。
  3. 按需複製 HTML 可把生成的安全 HTML 複製到相容的編輯器中。

用好本工具的小技巧

  • 以三個反引號圍起程式碼,可原樣保住原始碼的縮排與符號。
  • 本預覽有意把原始 HTML 以文字呈現,為的是減低指令碼注入之險。
  • 表格與巢狀清單最易因縮排深淺而走樣,宜對著預覽逐行調整。

這些情境會用到

邊寫 README 邊確認時

**寫作環境裡所見,未必與 GitHub 上呈現的一致。** 推送之前,先看一眼為宜。

調整表格與巢狀清單時

結果隨符號位置與縮排深淺而變的地方,用眼睛看著改,比推敲來得快。

把文章轉成 HTML 帶走時

**生成的 HTML 可照原樣複製**,用作貼進內容系統之前的底稿正合適。

把給人的資料做成 PDF 時

用 Markdown 寫下的操作手冊與筆記,可整理成可直接分發的樣子。

一邊記住記法一邊寫時

**輸入與結果並排,哪一個符號變成什麼,試著試著便記住了。**

Markdown 的術語

Markdown
以符號標示標題與強調的輕量記法。**並無單一的官方規範,各處理系之間存有差異。**
CommonMark
把原先含混之處嚴格定下的規範。如今多數實作以它為底。
GitHub Flavored Markdown
在 CommonMark 之上添了表格、刪除線、工作清單的擴充。**GitHub 上的呈現依此而定。**
換行的處理
**多數處理系裡,一次換行並不會在段落內斷行。** 須在行尾留兩個空格,或夾一個空行。
圍欄程式碼區塊
以三個反引號圍起的一段。在起始處標上語言名,便能著色。
淨化
把貼來的 HTML 中危險的元素剔除的處理。**本預覽為安全呈現而施行此舉。**

常見問題

不會。算繪與複製都在您的瀏覽器內就地完成。

不會。原始 HTML 一律轉義,以文字呈現。

支援常用的書寫記法,含標題、強調、連結、清單、引用、分隔線與圍欄程式碼區塊。

多數 Markdown 處理系裡,一次換行不作段落內的斷行。請在行尾留兩個空格,或夾一個空行。
工具君

為何發布之前要先預覽

Markdown 寫來輕省,可少一個符號便足以改變整頁的結構。有了即時預覽,標題、連結與清單的模樣在貼進 README、議題、維基或內容系統之前便一目了然。

本工具寧取一套安全的通用子集,也不去執行任意的 HTML。如此一來,無論是核對自不明來源複製來的內容,還是起草自己的文字,都用得順手。