Generate documentation with executable script blocks that MdExplorer can parse and run via interactive dialogs.

Install

mkdir -p .claude/skills/mde-readme && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/14880" && unzip -o skill.zip -d .claude/skills/mde-readme && rm skill.zip

Installs to .claude/skills/mde-readme

Activation

This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.

Write README sections that include runnable script examples MdExplorer can execute interactively. Use whenever you document a CLI tool, build/deploy script, dev task, or any command-line invocation in a README, sprint note, or how-to doc. Each example must declare its parameters in a way MdExplorer's runner can detect, so the user can fill them in a dialog and click ▶ Run.
375 charsno explicit “when” triggerlonger than Claude Code's old 250-char listing cap (fine on current versions)
Beginner

Key capabilities

  • →Write README sections with runnable script examples
  • →Declare parameters for script examples using `@param` headers
  • →Use placeholder tokens for user-supplied values in scripts
  • →Specify default values for parameters
  • →Mark sensitive parameters as secret

How it works

The skill defines a convention for writing script examples in READMEs. MdExplorer parses these examples for parameters, presents a dialog for user input, and then executes the script with the substituted values.

Inputs & outputs

You give it
Markdown documentation with fenced code blocks following MdExplorer conventions
You get back
Interactive 'Run' buttons for script examples with parameter input dialogs

When to use mde-readme

  • →Documenting CLI tool installation commands
  • →Creating runnable build or deployment script examples
  • →Adding interactive developer task automation to project docs
  • →Defining parameterized shell scripts for team onboarding

About mde-readme

This skill guides the creation of README documentation containing command-line script examples. It ensures scripts are formatted with specific parameter headers and placeholders, allowing MdExplorer to identify them and provide an interactive 'Run' interface for users.

Write README sections that include runnable script examples MdExplorer can execute interactively. Use whenever you document a CLI tool, build/deploy script, dev task, or any command-line invocation in a README, sprint note, or how-to doc. Each example must declare its parameters in a way MdExplorer'

When not to use it

  • →When hardcoding example values directly into the call
  • →When quoting placeholder values in assignments or arguments
  • →When mixing different shell syntaxes in a single fenced block

Limitations

  • →Requires all relative paths in commands to be written relative to the project root
  • →Requires all paths to use forward slashes
  • →Does not support angle brackets for anything other than parameter placeholders

How it compares

This skill enables interactive execution of command-line examples directly from documentation, allowing users to fill in parameters via a dialog, unlike static code blocks that require manual copying and editing.

Compared to similar skills

mde-readme side by side with the closest alternatives in the catalog.

SkillInstallsUpdatedSafetyDifficulty
mde-readme (this skill)04moReviewBeginner
ml-paper-writing489moReviewAdvanced
docs-review1011moNo flagsBeginner
claude-md-improver2110moReviewBeginner

Try saying

Example prompts that trigger this skill in your AI assistant.

You might also like

ml-paper-writing

davila7

Write publication-ready ML/AI papers for NeurIPS, ICML, ICLR, ACL, AAAI, COLM. Use when drafting papers from research repos, structuring arguments, verifying citations, or preparing camera-ready submissions. Includes LaTeX templates, reviewer guidelines, and citation verification workflows.

4897

docs-review

metabase

Review documentation changes for compliance with the Metabase writing style guide. Use when reviewing pull requests, files, or diffs containing documentation markdown files.

1085

claude-md-improver

anthropics

Audit and improve CLAUDE.md files in repositories. Use when user asks to check, audit, update, improve, or fix CLAUDE.md files. Scans for all CLAUDE.md files, evaluates quality against templates, outputs quality report, then makes targeted updates. Also use when the user mentions "CLAUDE.md maintenance" or "project memory optimization".

2167

write-docs

tldraw

Writing SDK documentation for tldraw. Use when creating new documentation articles, updating existing docs, or when documentation writing guidance is needed. Applies to docs in apps/docs/content/.

665

update-docs

vercel

This skill should be used when the user asks to "update documentation for my changes", "check docs for this PR", "what docs need updating", "sync docs with code", "scaffold docs for this feature", "document this feature", "review docs completeness", "add docs for this change", "what documentation is affected", "docs impact", or mentions "docs/", "docs/01-app", "docs/02-pages", "MDX", "documentation update", "API reference", ".mdx files". Provides guided workflow for updating Next.js documentation based on code changes.

2543

wiki-architect

microsoft

Analyzes code repositories and generates hierarchical documentation structures with onboarding guides. Use when the user wants to create a wiki, generate documentation, map a codebase structure, or understand a project's architecture at a high level.

1144

Search skills

Search the agent skills registry