---
name: Cmux Markdown
slug: cmux-markdown
category: Automation
description: Cmux Markdown opens markdown files in a formatted viewer panel with live reload. Use it to display plans, documentation, or notes alongside the terminal with rich rendering of headings, code blocks, tables, and lists.
github: "https://github.com/manaflow-ai/cmux/tree/main/skills/cmux-markdown"
language: Swift
stars: 26034
forks: 2205
install: "npx degit https://github.com/manaflow-ai/cmux/tree/main/skills/cmux-markdown ~/.claude/skills/cmux-markdown"
installs_to: ~/.claude/skills/cmux-markdown
source_path: skills/cmux-markdown/SKILL.md
collection_size: 20
category_size: 1523
collection_url: "https://dirskills.com/collections/manaflow-ai/cmux"
added: 2026-08-14T07:12:07.232Z
last_synced: 2026-08-14T07:12:07.232Z
canonical_url: "https://dirskills.com/skills/cmux-markdown"
---

# Cmux Markdown

Cmux Markdown opens markdown files in a formatted viewer panel with live reload. Use it to display plans, documentation, or notes alongside the terminal with rich rendering of headings, code blocks, tables, and lists.

**Install:**

```bash
npx degit https://github.com/manaflow-ai/cmux/tree/main/skills/cmux-markdown ~/.claude/skills/cmux-markdown
```

## README

# Markdown Viewer with cmux

Write 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.

```bash
cmux markdown open plan.md                              # split next to the current terminal
cmux markdown open /path/to/PLAN.md
cmux markdown open design.md --workspace workspace:2    # also --surface, --window
```

Relative paths resolve against the caller's cwd and `~` expands; the resolved absolute path comes back in the output.

## Agent usage

Write 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.

To instruct coding agents in a project, add to its `AGENTS.md`:

```markdown
## Plan Display

When creating a plan or task list, write it to a `.md` file and open it in cmux:

    cmux markdown open plan.md

The panel renders markdown with rich formatting and auto-updates when the file changes.
```

## Rendering

Headings 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.

## Deep-dive references

| Reference | When to Use |
|-----------|-------------|
| [references/commands.md](references/commands.md) | Full command syntax, options, output shape, panel behavior |
| [references/live-reload.md](references/live-reload.md) | File watching, atomic writes, unavailable-file state, performance |