cmux-markdown

cmux-markdown

熱門

在格式化檢視面板中開啟 Markdown 檔案,並支援即時重新載入。當您需要在終端機旁以豐富渲染(標題、程式碼區塊、表格、清單)顯示計畫、文件或筆記時使用。

2.5萬星標
2021分支
更新於 2026/7/19
SKILL.md
唯讀
名稱
cmux-markdown
描述

在格式化檢視面板中開啟 Markdown 檔案,並支援即時重新載入。當您需要在終端機旁以豐富渲染(標題、程式碼區塊、表格、清單)顯示計畫、文件或筆記時使用。

使用 cmux 的 Markdown 檢視器

使用此技能在專屬面板中顯示 Markdown 檔案,具備豐富格式與即時檔案監控。

核心工作流程

  1. 將您的計畫或筆記寫入 .md 檔案。
  2. 在 Markdown 面板中開啟它。
  3. 當檔案在磁碟上變更時,面板會自動更新。
# 在目前終端機旁以分割面板開啟 Markdown 檔案
cmux markdown open plan.md

# 絕對路徑
cmux markdown open /path/to/PLAN.md

# 指定特定工作區
cmux markdown open design.md --workspace workspace:2

使用時機

  • 在終端機旁顯示代理計畫或任務清單
  • 工作時顯示文件、變更日誌或 README
  • 檢閱即時更新的筆記(例如,另一個程序正在寫入的計畫檔案)

即時檔案監控

當檔案在磁碟上變更時,面板會自動重新渲染。這適用於:

  • 直接寫入(echo "..." >> plan.md
  • 編輯器儲存(vim、nano、VS Code)
  • 原子檔案取代(寫入暫存檔,重新命名覆蓋原始檔)
  • 代理逐步更新的計畫檔案

如果檔案被刪除,面板會顯示「檔案無法使用」狀態。在原子取代期間,面板會在其短暫的重試視窗內嘗試自動重新連線。如果檔案稍後恢復,請關閉並重新開啟面板。

代理整合

開啟計畫檔案

將您的計畫寫入檔案,然後開啟它:

cat > plan.md << 'EOF'
# 任務計畫

## 步驟
1. 分析程式碼庫
2. 實作功能
3. 撰寫測試
4. 驗證建置
EOF

cmux markdown open plan.md

即時更新計畫

面板會即時重新載入,因此只需在工作進行時覆寫檔案:

# 當檔案變更時,Markdown 面板會自動更新
echo "## 步驟 1:完成" >> plan.md

建議的 AGENTS.md 指示

將此加入您專案的 AGENTS.md,以指示程式碼代理使用 Markdown 檢視器:

## 計畫顯示

建立計畫或任務清單時,將其寫入 `.md` 檔案並在 cmux 中開啟:

    cmux markdown open plan.md

面板會以豐富格式渲染 Markdown,並在檔案變更時自動更新。

路由

# 在呼叫者的工作區中開啟(預設 — 使用 CMUX_WORKSPACE_ID)
cmux markdown open plan.md

# 在特定工作區中開啟
cmux markdown open plan.md --workspace workspace:2

# 從特定表面分割開啟
cmux markdown open plan.md --surface surface:5

# 在特定視窗中開啟
cmux markdown open plan.md --window window:1

深入參考資料

參考資料 使用時機
references/commands.md 完整指令語法與選項
references/live-reload.md 檔案監控行為、原子寫入、邊界情況

渲染支援

Markdown 面板渲染:

  • 標題(h1-h6),h1/h2 帶分隔線
  • 圍欄程式碼區塊,等寬字型
  • 行內程式碼,高亮背景
  • 表格,交替行顏色
  • 有序與無序清單(巢狀)
  • 區塊引用,左側邊框
  • 粗體、斜體、刪除線
  • 連結(可點擊)
  • 水平線
  • 圖片(行內)

支援淺色與深色模式。