Step-by-Step Guide
step_guideConvert a recording's event log into a numbered how-to with ringed screenshots, captions, and marker headings, exported as Markdown or a self-contained HTML guide without typed text.
Instructions
Turn a recording's event log into a numbered how-to: a ringed screenshot and caption per step, marker headings; Markdown and/or one HTML file. Never includes typed text.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ocr | No | OCR shots for captions and secret boxes (default true; needs Windows OCR). | |
| input | No | Recording path (uses its .events.jsonl). | |
| title | No | Guide title. | |
| format | No | md + images/, self-contained html, or both (default). | |
| outputDir | No | Guide folder (default: new in SCREENCAST_HOME/edits). | |
| overwrite | No | Replace a guide already in outputDir. | |
| sessionId | No | Or a stopped session's id. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| outputDir | Yes |