cmux-markdown

Source excerpt starting at line 1.

1---2name: cmux-markdown3description: Open markdown files in a formatted viewer panel with live reload. Use when you need to display plans, documentation, or notes alongside the terminal with rich rendering (headings, code blocks, tables, lists).4---5 6# Markdown Viewer with cmux7 8Write a `.md` file, open it in a panel, and the panel re-renders whenever the file changes on disk. Use it for agent plans and task lists alongside the terminal, documentation and changelogs while working, and notes another process updates progressively.9 10```bash11cmux markdown open plan.md                              # split next to the current terminal12cmux markdown open /path/to/PLAN.md13cmux markdown open design.md --workspace workspace:2    # also --surface, --window14```15 16Relative paths resolve against the caller's cwd and `~` expands; the resolved absolute path comes back in the output.17 18## Agent usage19 20Write the full plan file first, then open it, so the panel never shows a partially written file. After that, overwrite or append freely: each write triggers a re-render, and atomic replacement (editor saves, `sed -i`, VS Code) is handled.21 22To instruct coding agents in a project, add to its `AGENTS.md`:23 24```markdown25## Plan Display26 27When creating a plan or task list, write it to a `.md` file and open it in cmux:28 29    cmux markdown open plan.md30 31The panel renders markdown with rich formatting and auto-updates when the file changes.32```33 34## Rendering35 36Headings h1-h6 (dividers on h1/h2), fenced code blocks in monospace, inline code with a highlighted background, tables with alternating row colors, nested ordered and unordered lists, blockquotes with a left border, bold/italic/strikethrough, clickable links, horizontal rules, and inline images. Light and dark mode both supported.37 38## Deep-dive references39 40| Reference | When to Use |41|-----------|-------------|42| [references/commands.md](references/commands.md) | Full command syntax, options, output shape, panel behavior |43| [references/live-reload.md](references/live-reload.md) | File watching, atomic writes, unavailable-file state, performance |44