preview-markdown

preview-markdown is a skill for Claude Code from veelenga/preview-skills. It costs 20 tokens per session (1,062 once invoked), scanned A, original, MIT.

A tool for opening Markdown files as formatted web pages with GitHub-style syntax highlighting and tables of contents. Markdown is a text format commonly used for documentation.

In plain words
What is it for?
Use it to preview a Markdown file or streamed Markdown, choose a background color, and optionally save the rendered page without opening a browser.
Why use it?
It lets you check how documentation will look without manually building a web page. It can also preview temporary text piped directly into the tool.

Skill for Claude Code

Written for Claude Code: user-invocable in frontmatter.

Good fit Use it to preview a Markdown file or streamed Markdown, choose a background color, and optionally save the rendered page without opening a browser.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/veelenga/preview-skills/preview-markdown
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add veelenga/preview-skills --skill preview-markdown
Clone the repo
git clone --depth 1 https://github.com/veelenga/preview-skills

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for preview-markdown

README.md
[![agentmods](https://agentmods.dev/badge/skills/veelenga/preview-skills/preview-markdown/github.svg)](https://agentmods.dev/skills/veelenga/preview-skills/preview-markdown)
Your own site
<a href="https://agentmods.dev/skills/veelenga/preview-skills/preview-markdown"><img src="https://agentmods.dev/badge/skills/veelenga/preview-skills/preview-markdown/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for preview-markdown

Your own site · 80×15
<a href="https://agentmods.dev/skills/veelenga/preview-skills/preview-markdown"><img src="https://agentmods.dev/badge/skills/veelenga/preview-skills/preview-markdown.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 20 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,062 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00020 $0.01062
Opus 5 $0.00010 $0.00531
Sonnet 5 $0.00004 $0.00212
Haiku 4.5 $0.00002 $0.00106

Measured 9d ago against content hash e476ab1e789d, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

preview-markdown scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 9d ago.

The scan reads SKILL.md. This mod also ships 8 executable files (config.sh, lib/browser-utils.sh, lib/content-utils.sh, …), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/preview-markdown/SKILL.md · 200 lines

How it starts

The opening of the file, as written. The whole thing — 200 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Preview Markdown Skill

GitHub-flavored Markdown viewer that generates beautiful HTML with syntax highlighting and automatic table of contents.

Agent Usage

When the user asks to preview a Markdown file, DO NOT build HTML manually. Use the Bash tool to execute this skill's run.sh script:

# Preview a file
./run.sh README.md

# Pipe content
cat docs.md | ./run.sh

The script handles all HTML generation and automatically opens the result in the browser. Do NOT open the file manually to avoid duplicate tabs.

Usage

# Preview a Markdown file
/preview-markdown README.md

# Pipe Markdown content (preferred for temporary content)
cat docs.md | /preview-markdown
echo "# Hello\n\nThis is **markdown**" | /preview-markdown

# With custom background color
/preview-markdown article.md --background "#ffffff"

Best Practice: For temporary or generated content, prefer piping over creating temporary files. This avoids cluttering your filesystem and the content is automatically cleaned up.

Options

The script works with sensible defaults but supports these flags for flexibility:

  • -o, --output PATH - Custom output path
  • --no-browser - Skip browser, output file path only

Features

  • GitHub-flavored Markdown rendering with full spec support
  • Syntax highlighting for code blocks (100+ languages)
  • Automatic TOC generation from headers
  • Task lists with checkboxes
  • Tables with formatting
  • Images and links fully supported
  • Math equations (LaTeX via KaTeX)
  • Emoji support
  • Footnotes and references
  • Responsive design adapts to screen size

When to Use This Skill

Use this skill when the user wants to:

  • Preview README or documentation files
  • Read formatted Markdown documents
  • Verify Markdown rendering before publishing
  • Share formatted documentation
  • Review pull request descriptions

Examples

Natural language requests:

  • "preview this README"
  • "show me the documentation"
  • "open the markdown file"
  • "visualize CONTRIBUTING.md"
  • "let me see the formatted docs"

Read the full file on GitHub · 200 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 9d ago First seen · 200 lines · 20 tokens per session scan A e476ab1e789d

Subscribe to this mod's changes

preview-markdown is a skill published in the GitHub repository veelenga/preview-skills (8 stars, last pushed 28d ago), licensed MIT. It adds 20 tokens to every session and 1,062 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

long-audio-transcript-processor

A workflow for checking, cleaning up, and splitting very long speech-to-text files into manageable sections. It keeps a glossary, topic notes, and progress records so work can continue later.

cafe3310/public-agent-skills · 32 tokens

im-local-kb

A local knowledge-base manager for turning chat logs into organized Markdown records and sourced project documents. A knowledge base is a searchable collection of stored information.

cafe3310/public-agent-skills · 27 tokens

long-audio-to-obsidian

A workflow for combining scattered voice-transcription project files into organized Markdown documents for Obsidian, a note-taking and knowledge-management app. It sorts transcript sections by the numbers in their filenames and groups related project material.

cafe3310/public-agent-skills · 35 tokens

agent-browser

A command-line browser automation tool for AI agents. It can navigate websites and operate Electron desktop applications, using a compact view of page controls and their references.

cafe3310/public-agent-skills · 36 tokens

yuque

Work with Yuque OpenAPI for reading, searching, creating, and updating users, groups, repos, docs, TOC structures, versions, and statistics. Use when Codex needs to operate on Yuque knowledge bases or documents, reorganize document placement in a repo, inspect API capabilities, or prepare guarded plans for destructive…

flc1125/skills · 72 tokens

getnote

A tool for working with Get 笔记, a note-taking and knowledge-management service. It can handle notes, images, links, tags, and knowledge bases through that service's API.

flc1125/skills · 83 tokens