使用方式
- 在編輯器中輸入 Markdown,或按下「試用範例」載入含有表格和工作清單的文件。
- 輸入時即可查看預覽即時更新。切換至「HTML 原始碼」即可檢視產生的標記。
- 依照文字的發布平台,開啟或關閉 GitHub Flavored Markdown 或單行換行功能。
- 將 HTML 複製到 CMS 或電子郵件中,或將結果下載為 .html 或 .md 檔案。
運作方式
Markdown 會使用 marked 轉換。這是一款廣泛使用的開放原始碼解析器,遵循 CommonMark 規範;啟用 GFM 選項後,也會支援 GitHub Flavored Markdown:包含可對齊欄位的管線表格、工作清單、~~刪除線~~,以及自動轉換裸露 URL 的連結。註腳、數學公式和 Mermaid 圖表不屬於這些規範,因此會以純文字顯示。
Markdown 可能包含原始 HTML,這些 HTML 會像大多數 Markdown 轉譯器一樣,不經修改直接傳遞。為了確保安全,預覽內容絕不會插入此頁面,而是在沙箱框架中呈現,且無法執行指令碼、提交表單、開啟彈出式視窗或存取此網站;其內容安全政策也會封鎖指令碼、外部樣式表、字型和框架。Markdown 中的 <script> 標籤或 onclick 屬性會顯示在 HTML 原始碼中,但不會執行。預覽中的連結會顯示,但無法開啟;如需前往連結,請複製 URL。
預覽採用中性的樣式表,外觀類似常見的 README 轉譯器;您的網站或 GitHub 可能會以不同方式呈現相同的 HTML。複製的 HTML 是不含樣式的純片段;下載的 .html 檔案則會加上基本樣式表,讓外觀與預覽一致。下載或複製的 HTML 不會經過消毒處理,因此若包含指令碼,貼上或開啟時就會執行。
範例
推送前檢查 README
貼上 README.md,確認表格欄位是否對齊、工作清單是否呈現為核取方塊,以及程式碼區塊是否正確使用圍欄標記,再將檔案推送到 GitHub。
為支援 HTML 的 CMS 撰寫內容
使用 Markdown 撰寫部落格文章草稿,接著按下「複製 HTML」,再將 <h2>、<p> 和 <ul> 標記貼到 CMS 的 HTML 編輯器中。
聊天訊息的換行方式
聊天應用程式的文字會以單一換行符號分隔各行。開啟「將單一換行視為 <br>」後,各行就會分開顯示,而不會合併成同一段落。
常見問題
貼上來自未知來源的 Markdown 安全嗎?
可以安全地用於預覽。轉換後的 HTML 會顯示在停用指令碼的沙箱框架中,因此文字中的 <script> 標籤或事件處理常式在此都不會造成影響。貼上匯出的 HTML 時請小心,因為它未經消毒處理。
為什麼圖片沒有顯示?
預設會封鎖其他網站的圖片,讓預覽不會發出網路要求。開啟「載入其他網站的圖片」即可顯示圖片。由於檔案不在此處,./docs/screenshot.png 這類相對路徑無法使用。
支援註腳、數學公式或圖表嗎?
不支援。此工具支援 CommonMark 和 GitHub Flavored Markdown(表格、工作清單、刪除線、自動連結)。註腳、LaTeX 數學公式和 Mermaid 圖表是擴充功能,在此預覽中會以純文字顯示。
為什麼單一換行不會另起一行?
在標準 Markdown 中,段落內的單一換行會視為空格。請在行尾加上兩個空格、留一個空白行,或開啟「將單一換行視為 <br>」。
隱私權
Markdown 會在您的瀏覽器中轉換,不會上傳或儲存。除非您允許載入其他網站的圖片,否則預覽不會從網際網路載入任何內容;允許後,系統會直接向圖片所在的主機要求圖片。