showboat

Generate demo.md files interleaving notes, executable code blocks, and captured outputs.

Updated Feb 5, 2026
One-click install
npx skills add https://github.com/mheers/opencode-sandbox --skill showboat
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: showboat
Source: https://github.com/mheers/opencode-sandbox/tree/main/skills/showboat
Command: npx skills add https://github.com/mheers/opencode-sandbox --skill showboat

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps you create a demo.md document that demonstrates a feature you just built.

Core Features & Use Cases

  • Blends commentary, executable code blocks, and captured output into a single demo.md.
  • Serves as readable documentation and reproducible proof of work for feature validation.
  • After implementing a feature, generate a showboat demo to prove functionality.

Quick Start

Run showboat init demo.md "<Title>" to create a new demo document and begin documenting your feature.

Frequently Asked Questions about showboat

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

FAQPage Schema
How do I generate executable demo documentation from feature code?

Executable demo documentation is generated by blending narrative commentary, code blocks, and captured outputs into a single demo.md file. This reproducible format serves as readable documentation and proof of work for feature validation.

What is the best way to create reproducible feature demonstrations for stakeholders?

Reproducible feature demonstrations are created by interleaving notes, executable blocks, and captured results in a demo.md file. This approach helps developers and product teams showcase new features, verify behavior, and communicate outcomes to stakeholders.

How do I initialize a demo.md file to document a new feature?

To initialize a demo.md file, run the command "showboat init demo.md \"<Title>\"" to create a new demo document and begin documenting your feature with executable code blocks and narrative.

Does generating demo docs require any special dependencies or environments?

Generating demo docs requires the showboat tool to blend narrative, code blocks, and outputs. The skill has no listed component dependencies, making it straightforward to integrate into existing development workflows.

Can I use executable code blocks to verify feature behavior after implementation?

Executable code blocks can be used to verify feature behavior by capturing and displaying outputs directly within the demo.md documentation. This provides reproducible proof of work that validates functionality after implementing a feature.