cmux-markdown

Display markdown files in a formatted viewer with live reload.

1|Updated Sep 6, 2015

Search Tags:#documentation #markdown #developer workflow #live reload #terminal viewing #workspace routing

Ready to run

npx skills add https://github.com/deerawan/dotfiles --skill cmux-markdown-deerawan

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: cmux-markdown
Source: https://github.com/deerawan/dotfiles/tree/main/agents/skills/cmux-markdown
Command: npx skills add https://github.com/deerawan/dotfiles --skill cmux-markdown-deerawan

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It solves the problem of reviewing and presenting markdown content in real time without constantly switching contexts between your terminal and a separate viewer.

Core Features & Use Cases

Rich markdown rendering: Headings, code blocks, tables, lists, links, and more display in a formatted viewer panel.
Live file watching: The panel automatically re-renders when the markdown file changes, including editor saves and atomic write patterns.
Workspace routing: You can open the same markdown file in a specific workspace, window, or surface to match your current workflow (e.g., agent plans alongside terminal work).

Quick Start

Run the command cmux markdown open plan.md to open your markdown file in a split panel that auto-updates as the file changes.

Frequently Asked Questions about cmux-markdown

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

FAQPage Schema

How do I view markdown files in a terminal workspace while editing?▼

You can view markdown files in a formatted viewer panel using the cmux markdown open command with an absolute or relative path, which renders headings, code blocks, and tables alongside your terminal workspace.

Does the markdown viewer panel live-reload when the file changes on disk?▼

Yes, the markdown viewer panel automatically live-reloads when the file changes on disk, successfully recovering from editor saves and atomic write patterns to keep the displayed content synchronized.

Can I open markdown documentation in a specific workspace or window surface?▼

Yes, workspace routing allows you to open the same markdown file in a specific workspace, window, or surface, enabling you to review agent plans or documentation directly alongside your active development workflow.

What is the best way to review agent plans and notes during iterative development?▼

The best way to review agent plans and notes is opening them in a split panel that auto-updates as the file changes, eliminating the need to switch contexts between your terminal and a separate viewer.

What markdown formatting features are supported in the viewer panel?▼

The viewer panel supports rich markdown rendering, displaying formatted headings, code blocks, tables, lists, links, and more directly within your development environment.

Do I need any external dependencies to use the markdown live reload viewer?▼

No external dependencies are required, as the skill operates independently to watch files and render formatted markdown, handling atomic-write recovery behaviors directly through the cmux markdown open invocation.