markdown-preview

Render Markdown files into terminal preview artifacts at configured widths.

9|3|Updated Apr 9, 2026
One-click install
npx skills add https://github.com/corca-ai/charness --skill markdown-preview-corca-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: markdown-preview
Source: https://github.com/corca-ai/charness/tree/main/plugins/charness/support/markdown-preview
Command: npx skills add https://github.com/corca-ai/charness --skill markdown-preview-corca-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Turn checked-in Markdown into durable terminal-rendered preview artifacts so doc-facing workflows can review real terminal output instead of raw source alone.

Core Features & Use Cases

  • Real-time Markdown rendering using a supported backend (glow) to produce width-specific text artifacts.
  • Repo-local configuration discovery for controlling scope, target widths, and artifact paths.
  • Graceful degradation when the glow backend is unavailable, emitting explicit degraded artifacts and indicating the backend issue.
  • Use case: provide readable previews of README and docs for review in documentation pipelines.

Quick Start

Run the Markdown Preview helper to render README.md at the specified widths and inspect the generated artifacts.

Frequently Asked Questions about markdown-preview

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

FAQPage Schema
How do I render Markdown previews for repository documentation?

Render Markdown previews by converting checked-in READMEs and docs into durable terminal-rendered text artifacts. This generates width-specific outputs that improve readability for documentation review and collaboration workflows.

What is a terminal-rendered Markdown preview artifact?

A terminal-rendered Markdown preview artifact is a durable text file generated from repository Markdown source. It captures the exact terminal output appearance using a Glow-compatible backend, allowing reviewers to inspect formatted docs without running a live renderer.

Do I need Python and Glow to render Markdown previews in my repository?

Yes, rendering Markdown previews requires Python 3 and a Glow-compatible backend to produce width-specific text artifacts. If the Glow backend is unavailable, the process gracefully degrades by emitting explicit degraded preview artifacts indicating the backend issue.

Can I configure Markdown rendering widths and artifact paths for my docs?

Yes, you can control rendering scope, target widths, and artifact paths through repo-local configuration discovery. This allows documentation workflows to generate terminal-rendered previews tailored to specific review requirements.

What happens when the Glow backend is unavailable during Markdown rendering?

When the Glow backend is unavailable, the Markdown rendering process gracefully degrades by emitting explicit degraded preview artifacts. These artifacts indicate the backend issue, ensuring documentation workflows continue without failing completely.

Best way to automate Markdown rendering for documentation pipelines?

Automate Markdown rendering by running a helper script that discovers repo-local config and renders checked-in docs at specified widths. This produces durable terminal-rendered preview artifacts, providing readable outputs for automated documentation review pipelines.