Skip to content
Skillpedia
Websites & UI (frontend)48k · #3546

markdown-rendering

Allows your agent to open and view Markdown files correctly. It ensures content is displayed clearly, even if the rendering initially fails.

What it does

This tool helps display formatted text files (called Markdown) in a specific area of your program called cmux. It ensures the text appears correctly, even if the program normally has issues.

When to use it

  • ✓When a Markdown file appears blank or with incorrect formatting in cmux.
  • ✓When you need to show a Markdown file in a fixed area of cmux.
  • ✓When trying to open a Markdown file results in an error or incorrect display.

Example of what to ask your AI

“Open the file 'document.md' in the right pane of cmux, ensuring the formatting is correct.”

Want more? Open the sections below.

How to use

The easiest way: copy the message below and paste it into Claude, ChatGPT, Cursor or any AI. It reads the skill and follows the instructions.

Skill link

https://github.com/sickn33/agentic-awesome-skills/blob/main/plugins/agentic-awesome-skills-claude/skills/markdown-rendering/SKILL.md

Ready-to-paste message

Use this skill to help me: https://github.com/sickn33/agentic-awesome-skills/blob/main/plugins/agentic-awesome-skills-claude/skills/markdown-rendering/SKILL.md Read the SKILL.md file at that link and follow its instructions for my task.
How it works

The tool avoids a common error where moving the Markdown viewing area causes it to go blank. It does this by either opening the file directly in the correct area or by closing conflicting areas before reopening the file.

Installation

Easiest way: copy the skill link and paste it into Claude, ChatGPT or Cursor asking it to follow the instructions.

In the terminal (Claude Code, Codex, Cursor), in your project folder:

npx skills add sickn33/agentic-awesome-skills --skill markdown-rendering

Or download just the file:

curl -L https://raw.githubusercontent.com/sickn33/agentic-awesome-skills/main/plugins/agentic-awesome-skills-claude/skills/markdown-rendering/SKILL.md -o SKILL.md
Technical content (original SKILL.md)

Original text by the author, straight from GitHub.

Markdown Rendering in cmux

When to Use

  • Use when opening Markdown in cmux shows a blank pane or wrong layout.
  • Use when you need to display a Markdown file in a stable cmux right pane.

The Problem

cmux markdown open defaults to spawning a brand-new pane every time, even with --direction right. The common "fix" — moving the new markdown surface into the existing right pane with move-surface — bugs out: the moved viewer renders BLANK. The surface keeps type=markdown and looks healthy, but shows nothing.

So you get stuck: either a stray extra pane, or a blank viewer after moving it.

The Rule

The contributor observed two workarounds for a particular cmux version. Verify the installed command/version; the blank-render issue may have changed. Prefer reopening an owned viewer without altering unrelated panes.

Option A — Open it right on the first try

If there is no usable right pane yet, just let cmux create one and leave it where it lands:

cmux markdown open /abs/path/file.md --direction right --focus false

Do NOT then move it. If it spawned where you want it, you're done.

Option B — Close existing right pane(s), then open fresh

If there are other right panes in the way (and they're unused or irrelevant), close them first, then open the markdown fresh as a new right pane:

# 1. find panes in THIS workspace
cmux list-panes --workspace "$CMUX_WORKSPACE_ID"

# 2. close the unused/irrelevant right pane(s) by closing their surfaces
cmux list-pane-surfaces --pane pane:NN
cmux close-surface --surface surface:XX     # repeat per surface in that pane

# 3. THEN open the markdown fresh — it creates its own clean right pane
cmux markdown open /abs/path/file.md --direction right --focus false

Hard Rules

  • Never move-surface a markdown viewer. It renders blank afterward. This is the core bug this skill exists for.
  • Open it correctly the first time (Option A), OR close the conflicting right pane(s) and open a fresh right pane from scratch (Option B).
  • Close only surfaces created for this task or explicitly authorized for closure; apparent irrelevance does not prove they contain no unsaved work.
  • Always anchor to $CMUX_WORKSPACE_ID; never assume the visually focused workspace.
  • Pass --focus false so you don't steal the user's focus.
  • Use any supported readback/rendered inspection available on the actual host. If it cannot inspect the viewer, report that limit instead of claiming success.

Limitations

  • Adapted from davidondrej/skills; verify local paths, tools, credentials, and agent features before acting.
  • For commands, remote access, scheduling, browser automation, or file-changing workflows, get explicit user approval and confirm the target environment first.
FAQ

Why does my Markdown file appear blank in cmux?

This often happens because the program tries to create a new pane for the file, and when it's moved, the viewer fails and goes blank. This tool is designed to bypass that issue.

What is 'cmux'?

cmux is a program that allows you to organize and manage multiple windows or workspaces on your computer, like panels.

What is 'Markdown'?

Markdown is a simple way to write text that can be easily turned into web pages or other formatted documents, using simple symbols like asterisks for bold.

Details

Original description by the author

Open Markdown reliably in cmux panes and recover from blank rendered surfaces.

repo: sickn33/agentic-awesome-skills

Popularity

GitHub stars
48k
Ranking position
#3546
License
MIT
Updated
10/15/2026

Is this skill useful?

0

Sign in to vote.

Comments

  • …

More skills from this repository

Similar skills