Markdown 編輯器

撰寫 Markdown 語法,即時預覽結果。

使用範例

撰寫 README 或技術文件草稿

想確切知道你的 GitHub README 或文件最終會長什麼樣子嗎?在左側輸入,即可即時在右側看到渲染後的結果。

確認表格或清單是否正確呈現

對 Markdown 表格語法沒把握嗎?輸入的同時就能馬上看到表格和清單的實際呈現效果。

接續上次未完成的內容

你輸入的內容會自動儲存在瀏覽器中,就算關閉頁面,之後回來也能接續撰寫。

撰寫含檢查清單的 Pull Request 描述

撰寫含有 '- [ ] Tests added' 這類檢查清單與巢狀項目符號的 PR 描述,並在貼上之前,預覽 GitHub 將如何呈現核取方塊與縮排。

為含程式碼片段的發行說明排版

撰寫混合標題、項目符號變更記錄,以及函式名稱的行內 `code` 的發行說明,然後確認升級指令的圍欄式程式碼區塊,是否以正確的語言醒目提示呈現。

常見問題

我寫的內容會儲存在伺服器上嗎?

不會。所有編輯與預覽渲染都完全在你的瀏覽器中進行。為了讓你能接續上次的內容,你的內容只會儲存在瀏覽器的本機儲存空間(localStorage)中,絕不會傳送到伺服器,也不會在裝置之間共用。

有哪些 Markdown 語法不支援嗎?

標題、粗體/斜體/刪除線、清單、引言、程式碼(行內與區塊)、連結、圖片,以及表格(GFM 擴充語法)——這些常用語法都支援。如果你在內容中混入原始 HTML 標籤,基於安全考量,它們只會以純文字顯示,不會被執行。

我寫的內容可以用在別的地方嗎?

可以。點擊上方的「複製」,即可將你寫的全部內容複製到剪貼簿。或是點擊「匯出為 README.md」,將內容下載成檔案,直接上傳到 GitHub 儲存庫或任何地方。

為什麼我的單一換行,在預覽中不會顯示為新的一行?

這遵循標準 Markdown(CommonMark)規則:段落內的單一換行會被視為空格,而不是換行。若要強制換行,請在行尾加上兩個以上的空格,或留下完整的空白行以開始新段落。

可以將清單與引言互相巢狀嗎?

可以。將清單項目縮排兩個空格,就會巢狀在上方項目之下,你也可以用相同方式,在清單項目中放入引言、程式碼區塊或另一個清單——預覽會在你輸入時反映巢狀結構。

工具列支援鍵盤快速鍵嗎?

工具列按鈕會在游標位置插入正確的 Markdown 語法(例如以 ** 包住選取的文字來設為粗體),但它是供滑鼠或觸控使用——除了瀏覽器與作業系統一般的文字編輯快速鍵之外,沒有專屬的鍵盤快速鍵。

如果我不小心關閉分頁,內容會怎樣?

由於你的內容會在你輸入時儲存到 localStorage,在同一個瀏覽器中重新開啟工具,就能完整還原你原本的內容。只有在你清除瀏覽器的網站資料,或改用其他瀏覽器或裝置時,才會遺失。