cmux-markdown

Render Markdown documents in a live cmux panel beside the terminal.

Updated Mar 21, 2026

Search Tags:#documentation #markdown #notes #panels #viewer #live-reload #cmux

Ready to run

npx skills add https://github.com/Derek-X-Wang/skills --skill cmux-markdown-derek-x-wang

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: cmux-markdown
Source: https://github.com/Derek-X-Wang/skills/tree/main/cmux-markdown
Command: npx skills add https://github.com/Derek-X-Wang/skills --skill cmux-markdown-derek-x-wang

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Markdown files are often edited in isolation; this skill provides a live viewer that renders them in a dedicated panel beside the terminal, keeping context visible as you work.

Core Features & Use Cases

Live rendering of Markdown files in a dedicated cmux panel alongside the terminal.
Auto-refresh on file changes so plans, docs, or notes stay in sync during editing.
Use cases include agent plans, READMEs, design notes, and project documentation that you want visible while working.

Quick Start

Open a Markdown file in a cmux panel by running cmux markdown open <path-to-file>.

Frequently Asked Questions about cmux-markdown

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I view a Markdown file alongside my terminal while working?▼

You can view a Markdown file alongside your terminal by rendering it in a dedicated live cmux panel, keeping plans and documentation visible without leaving the command line.

Can I get live auto-refresh of Markdown documentation during editing?▼

Yes, live rendering of Markdown documentation supports auto-refresh on file changes, ensuring plans, READMEs, and design notes stay in sync as you edit them.

What is the best way to keep project notes visible while running terminal commands?▼

The best way to keep project notes visible is opening them in a dedicated cmux panel that renders Markdown in a live formatted viewer beside your terminal workspace.

Does the live Markdown viewer support frontmatter for organizing notes?▼

Yes, the live Markdown viewer supports frontmatter-based discovery and on-demand rendering, allowing organized access to documentation and notes that evolve during work.

How do I open a README in a formatted panel using cmux?▼

To open a README in a formatted panel, run the command cmux markdown open followed by the file path, which renders the document in a live viewer beside the terminal.

What types of documents work best with live Markdown rendering?▼

Live Markdown rendering works best for evolving documents like agent plans, READMEs, design notes, and project documentation that need to stay visible and synchronized during active work.