cmux-markdown

Open markdown files in a formatted cmux panel with live reload on file changes.

4.0k|282|Updated Dec 2, 2024
One-click install
npx skills add https://github.com/basicmachines-co/basic-memory --skill cmux-markdown-basicmachines-co
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: cmux-markdown
Source: https://github.com/basicmachines-co/basic-memory/tree/main/.agents/skills/cmux-markdown
Command: npx skills add https://github.com/basicmachines-co/basic-memory --skill cmux-markdown-basicmachines-co

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Viewing plans, documentation, or notes alongside a terminal usually requires switching windows or reading raw markdown text. This Skill renders markdown files in a dedicated cmux panel with rich formatting and automatically re-renders whenever the file changes on disk. ## Core Features & Use Cases - Formatted Markdown Panel: Opens any .md file as a split panel with rendered headings, code blocks, tables, lists, blockquotes, links, and images in light or dark mode. - Live Reload: Watches the file with a kernel-level watcher and re-renders on every write, including atomic editor saves and progressive agent writes. - Flexible Targeting: Supports --workspace, --surface, and --window flags plus JSON output for scripting panel placement. - Use Case: A coding agent writes a plan to plan.md, runs cmux markdown open plan.md, and the user watches the task list update in real time beside the terminal as the agent checks off items. ## Quick Start Write your plan or notes to a markdown file, then ask the agent to run cmux markdown open on that file so it appears in a live-updating panel next to the terminal.

Frequently Asked Questions about cmux-markdown

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

FAQPage Schema
How do I open a markdown file in a cmux panel?▼

Run cmux markdown open followed by the file path, such as cmux markdown open plan.md. Relative paths resolve against the current directory, and the panel opens as a split next to the current terminal surface.

How does live reload work for markdown files in cmux?▼

The panel watches the file with a kernel-level DispatchSource watcher and re-renders on every write. Direct writes, editor saves, sed -i, and atomic replace patterns are all detected and handled automatically.

Can I open a markdown panel in a specific cmux workspace or window?▼

Yes, use the --workspace, --surface, or --window flags to target a specific location, for example cmux markdown open design.md --workspace workspace:2. The --json flag returns the created surface and pane identifiers.

What happens if the markdown file is deleted while the panel is open?▼

The panel detects the deletion, retries briefly, then shows a file unavailable state with the original path. It stays open until closed but does not reconnect if the file reappears; close and reopen the panel.

Are there file size limits for the cmux markdown viewer?▼

Re-renders run synchronously on the main thread, so files over roughly 100KB can cause brief UI hitches during reload. Splitting very large documents into smaller files avoids this issue.