自述檔案 Markdown 預覽和瀏覽器優先編輯
當瀏覽器優先的 Markdown 工作區是在不離開頁面的情況下起草、預覽和共享 README 樣式內容的最快方式時,請使用本指南。
編輯器提供即時預覽、分欄檢視和預設。它是草稿工具,不能替代倉庫歷史或評審。
適用場景
您需要快速的自述檔案、發行說明或執行手冊草稿,具有即時預覽功能,並且無需安裝強制編輯器。
首先檢查什麼
在您認為 Markdown 本身是問題之前,請先檢查檢視模式、預覽渲染並共享狀態。
護欄
草稿儲存在本裝置的瀏覽器儲存中。清除站點資料會丟失草稿;在你複製分享連結之前,不會有任何內容進入 URL。
README 大綱
當您在編寫最終詳細資訊之前需要標題結構時,請從自述檔案預設開始。
# Project Overview
## Install
## Usage
釋出說明
當作業要清晰地格式化更改以便讀者快速瀏覽時,請使用發行說明草稿。
# Release Notes
- Added safer share handling
- Fixed layout regressions
事故處理手冊
當 Markdown 將成為操作指南而不是營銷文案時,請切換到操作手冊模式。
## Triage
1. Confirm impact
2. Capture rollback window
3. Share updates
當您需要快速草稿、即時預覽和受控共享行為而不需要進入更繁重的創作堆疊時,Markdown 編輯器是最強大的。
- 首先使用分割檢視,以便源和渲染輸出保持可見。
- 將本地草稿儲存和顯式共享 URL 視為單獨的工作流程。
預設連結可以安全地廣泛共享,而明確的草稿 URL 僅應在需要傳輸確切的 Markdown 正文時才複製。
- 如果草稿對於 URL 來說太大,請繼續使用本地瀏覽器工作流程,而不是強制其進入共享狀態。
- 當審閱範圍是比較兩個文件修訂版而不是預覽一份活動草稿時,請使用 diff。