cmux-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 带分隔线
• 围栏代码块，等宽字体
• 内联代码，高亮背景
• 表格，交替行颜色
• 有序和无序列表（嵌套）
• 块引用，左侧边框
• 粗体、斜体、删除线
• 链接（可点击）
• 水平线
• 图片（内联）

支持浅色和深色模式。