Markdown Preview
Live Markdown preview
Live Markdown preview 在您的瀏覽器中本地執行
About the
當您鍵入時，Markdown 預覽會在並排檢視中呈現您的 Markdown，遵循 CommonMark 以及大多數人實際使用的 GitHub 擴充功能：表格、任務清單、隔離程式碼區塊、刪除線和自動連結。這是在提交之前檢查 README 的最快方法，因為 Markdown 在原始程式碼中的外觀與呈現的外觀之間的差異並不明顯，尤其是當單一管道或破折號錯誤時，表語法會默默地失敗。如果您需要在不處理 Markdown 的地方使用渲染的 HTML，也可以複製出來。
Where people use the
- 在推送之前檢查自述檔案是否正確呈現。
- 起草發布說明或變更日誌以及結果的即時檢視。
- 對於不接受 Markdown 的 CMS，將 Markdown 檔案轉換為 HTML。
- 檢視其他人的 Markdown Pull 請求並看看它會是什麼樣子。
How to use the
- 1
貼上或編寫您的 Markdown
編輯器接受從單一段落到包含標題、清單、連結和程式碼圍欄的完整檔案的任何內容。
- 2
觀看渲染面板
每次擊鍵都會更新預覽，因此損壞的表格或未關閉的柵欄會立即顯示，而不是在發布步驟之後顯示。
- 3
修復來源，而不是預覽
預覽是唯讀的。當某些內容呈現錯誤時，原因幾乎總是在沒有分隔符號行的列表或表標題之前缺少空白行。
- 4
如果需要，請複製 HTML
切換到 HTML 檢視以取得產生的標記，這對於貼在需要 HTML 而不是 Markdown 的 CMS 中非常有用。
提示和最佳實踐
- 每個區塊元素前後各留一個空白行；最令人費解的渲染錯誤是缺少空白行。
- 使用帶有語言名稱的隔離程式碼區塊，以便程式碼突出顯示而不是被視為純文字。
- 在長文件中每行保留一句話；它使差異稍後可讀。
常見問題
使用哪一種 Markdown 規範？
以 CommonMark 為基礎，加上表格、任務清單、隔離程式碼和刪除線的 GitHub Flavored Markdown 擴充。該組合涵蓋了 GitHub、GitLab 和大多數檔案網站上的 README 格式。
為什麼我的表格沒有呈現？
表格需要一個標題行，緊接著是一個由破折號組成的分隔符號行，區塊之前有一個空白行。每行的管道數量必須與標題相同。任何一個缺失都會將整個內容變成一段帶有管道字元的文字。
為什麼我的清單專案合併為一個段落？
Markdown 需要在段落和其後的列表之間有一個空行。如果沒有它，則清單標記將被視為普通文字。
它支援 LaTeX 或數學嗎？
不可以。數學渲染需要單獨的庫（例如 KaTeX 或 MathJax）和不同的語法。此處的美元符號表示式將呈現為純文字。
是否允許原始 HTML？
是的，內嵌 HTML 直接通過，這也是 GitHub 所做的。如果您將輸出釋出到任何公開的地方，請先對其進行清理，因為原始 HTML 也是注入指令碼的方式。
我的文字去哪了？
無處。解析和渲染透過 JavaScript Markdown 庫在瀏覽器中進行。不會儲存或傳輸任何內容，因此當您關閉選項卡時，草稿就會消失，除非您將其複製出來。