先閱讀文件,再決定要修改什麼
收到 README 或筆記,只想先檢視內容時,可以開啟 .md 檔案並選擇「預覽」,直接閱讀排版後的文件。需要修改時再切換到「編輯」或「分割畫面」,原始內容始終可以檢查和儲存。
常用操作支援快速鍵,已有草稿也可直接開啟。本機草稿只會在你選擇儲存後寫入目前的瀏覽器設定檔,不會同步至雲端。
讓原始內容保持可見的編輯工具
檢視 MD 檔案,不必先編輯
預覽模式會隱藏原始內容面板,方便閱讀標題、清單、表格與程式碼。看完後仍可切回編輯,文件內容不會因切換檢視而丟失。
複雜內容有插入起點
建立基本表格、加入行內或獨立公式和 Mermaid 範例,也可以插入本機點陣圖片,再直接修改對應的原始內容。
邊寫邊檢查預覽效果
分割畫面模式同時顯示原始內容和排版結果,輸入稍作停頓後更新預覽,便於檢查表格對齊、程式碼區塊和支援的公式。較長文件暫停自動預覽時,可以手動更新。
按自己的方式工作
支援編輯、預覽、分割畫面與專注模式,可調整字型與文件縮放,隨時下載 Markdown 保留可遷移的副本。
從真正要交付的文件開始
專案 README
先閱讀 README,檢查說明是否清楚;需要修改安裝步驟時,再切換到分割畫面。
# 專案名稱 用一句話說明**這個專案解決什麼問題**。 ## 開始使用 ```bash npm ci ``` ## 下一步 - [ ] 補充可執行範例 - [ ] 檢查使用說明
- 首段說明用途
- 命令放入程式碼區塊
- 清單有明確動作
包含圖表的決策筆記
讓文字解釋與工作流程儲存在同一份原始檔裡。
# 評審流程 ```mermaid flowchart LR A[起草] --> B[檢查] B --> C[分享] ``` 分享前由評審者核對關鍵結論。
- 圖表語法正確
- 節點文字清楚
- 正文解釋圖表含義
開啟、預覽並儲存文件
開啟檔案或貼上內容
點選「開啟檔案」選擇 .md 文件,也可以直接貼上 Markdown。閱讀 GitHub README 時,請先儲存原始檔案;輸入網頁地址不會自動匯入文件。
選擇閱讀或分割畫面編輯
只閱讀時選擇「預覽」,需要修改時選擇「分割畫面」,邊寫邊檢查效果。標題、連結、清單和表格可以從工具欄插入,不必記住所有語法。
保留可以繼續編輯的副本
下載 MD,把原始檔儲存在自己的裝置上。需要排版後的檔案時可下載 HTML,準備分享時可使用 PDF 工具。本機草稿儲存由你選擇,不能代替檔案備份。
分享前,檢查這幾項
| 內容 | 建議操作 | 可以期待的結果 |
|---|---|---|
| 誤加的格式 | 使用工具欄後檢查對應原始內容。 | 粗體和清單仍是一般 Markdown,可隨時手動修改。 |
| 草稿恢復 | 開啟儲存後編輯一小段,再重新整理並恢復。 | 草稿依賴目前裝置,可能被瀏覽器清理。 |
| AI 產生的內容 | 核實事實,修正不完整程式碼圍欄或不支援的公式。 | 排版可提升可讀性,但不能保證內容正確。 |
這個任務的常見問題
只想檢視 MD 檔案,不編輯也可以嗎?
可以。點選「開啟檔案」選擇 .md 文件,再切換到「預覽」,就能直接閱讀排版後的內容,不必修改原始內容。需要調整時再切回編輯或分割畫面即可。
怎樣邊寫 Markdown 邊檢視效果?
開啟檔案或貼上原始內容後選擇「分割畫面」。輸入稍作停頓,右側就會更新效果。較長文件暫停自動預覽時,點選「更新預覽」即可。編輯與檢視都在瀏覽器中完成,無需上傳文件。
不熟悉 Markdown 語法也能使用嗎?
工具欄可插入常用語法,範例提供起點。保留可見原始內容,也方便了解每個按鈕具體修改了什麼。
草稿儲存在哪裡?
只在主動開啟儲存在本機時寫入目前瀏覽器,不跨裝置同步;清除瀏覽器儲存後草稿也會消失。需要長期保留時請下載 MD。
特別長的文件如何處理?
你仍可編輯和下載原始內容。為保持編輯響應,自動預覽可能暫停;需要檢視時可以手動更新。
支援 HTML 標籤嗎?
支援用於底線、上標、下標、鍵盤按鍵和醒目提示的少量無屬性格式標籤,其他原始 HTML 按文字顯示。
可以編寫數學公式和流程圖嗎?
可以渲染 KaTeX 支援的公式與 Mermaid 程式碼區塊。錯誤會被標出,便於在渲染匯出前修正原始內容。
文件會怎樣被處理
- 編輯器和預覽在瀏覽器中執行。
- 本機草稿儲存由你開啟,也可以關閉或清除。
- PDF 下載會另外交由伺服器處理;你也可以選擇本機列印或下載 MD/HTML。
格式參考CommonMark 入門GitHub Flavored Markdown 規範
反饋可復現的問題請說明瀏覽器、所選設定,並附上不含隱私的最小範例。不要透過郵件傳送私密文件。