cmux-markdown

Render local markdown files in a cmux viewer panel with live reload.

Updated Mar 11, 2026
One-click install
npx skills add https://github.com/selfagency/agentsy --skill cmux-markdown-selfagency
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cmux-markdown
Source: https://github.com/selfagency/agentsy/tree/main/.agents/skills/cmux-markdown
Command: npx skills add https://github.com/selfagency/agentsy --skill cmux-markdown-selfagency

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

You need to read and update markdown plans, documentation, or notes while working in a terminal, and you want them rendered clearly without repeatedly opening and refreshing files.

Core Features & Use Cases

  • Formatted markdown viewing: renders headings, code blocks, tables, lists, links, and more in a dedicated panel.
  • Live file watching: automatically re-renders when the markdown file changes, including common editor save and atomic replace patterns.
  • Workspace-aware routing: opens the panel in a selected cmux workspace/surface/window for side-by-side workflow.
  • Use Case: while an agent progressively writes a plan into plan.md, you keep the rendered view open so you can monitor updates in real time.

Quick Start

Write your notes to a plan.md file, then open it in a split markdown panel with auto-updates by running: cmux markdown open plan.md.

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 with live reload in a terminal split?

To view markdown files with live reload in a terminal split, open the file in a formatted cmux viewer panel. The panel automatically re-renders content when the file changes on disk, handling common editor save and atomic replace patterns for real-time updates.

Can I monitor dynamically updated markdown documentation alongside terminal work?

You can monitor dynamically updated markdown documentation alongside terminal work by opening it in a dedicated cmux panel. This workspace-aware routing displays rendered plans, READMEs, and changelogs side-by-side with your active development environment.

What is the best way to render a markdown plan that an agent progressively writes?

The best way to render a progressively written markdown plan is to open the file in a cmux markdown panel. It provides live file watching via on-disk change detection, allowing you to monitor agent-run workflow updates in real time.

Does the cmux markdown viewer require a specific entrypoint format?

The cmux markdown viewer requires a valid SKILL.md YAML entrypoint to function. Once the entrypoint is validated, you can open any local markdown path with optional workspace, surface, or window routing for side-by-side workflows.

What happens when an editor uses atomic replacement to save a markdown file?

When an editor uses atomic replacement to save a markdown file, the cmux viewer includes atomic replacement recovery to maintain the live reload. This ensures the formatted panel continues to display updated content without breaking the file watching process.

Are there limitations to the markdown formatting rendered in the cmux panel?

The cmux panel renders standard markdown formatting including headings, code blocks, tables, lists, and links. It is designed for displaying local documentation, plans, and notes rather than processing external web URLs or non-markdown file formats.