cmux-markdown

Solid

Open markdown files in a cmux 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). Requires cmux environment ($CMUX_WORKSPACE_ID).

Data & Documents 47 stars 4 forks Updated 4 days ago MIT

Install

View on GitHub

Quality Score: 87/100

Stars 20%
56
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Markdown Viewer with cmux Use this skill to display markdown files in a dedicated panel with rich formatting and live file watching. Requires cmux environment (`$CMUX_WORKSPACE_ID`). Outside cmux, this skill's features are unavailable. ## Core Workflow 1. Write your plan or notes to a `.md` file. 2. Open it in a markdown panel. 3. The panel auto-updates when the file changes on disk. ```bash # Open a markdown file as a split panel next to the current terminal cmux markdown open plan.md # Absolute path cmux markdown open /path/to/PLAN.md # Target a specific workspace cmux markdown open design.md --workspace workspace:2 ``` ## When to Use - Displaying an agent plan or task list alongside the terminal - Showing documentation, changelogs, or READMEs while working - Reviewing notes that update in real-time (e.g., a plan file being written by another process) ## Live File Watching The panel automatically re-renders when the file changes on disk. This works with: - Direct writes (`echo "..." >> plan.md`) - Editor saves (vim, nano, VS Code) - Atomic file replacement (write to temp, rename over original) - Agent-generated plan files that are updated progressively If the file is deleted, the panel shows a "file unavailable" state. During atomic replace, the panel retries within a short window. If the file returns later, close and reopen the panel. ## Agent Integration ### Opening a plan file Write your plan to a file, then open it: ```bash cat > plan.md << 'EOF' # Tas...

Details

Author
LeeJuOh
Repository
LeeJuOh/claude-code-zero
Created
4 months ago
Last Updated
4 days ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category