Reference
Story and doc API
Section titled “Story and doc API”The same story structure and doc model in every adapter. Where a host framework forces a difference, the page says so.
Viteststory.init(task), steps, doc methods, scenario options.
Jeststory.init(), plus the top-level given/when/then exports.
Playwrightstory.init(testInfo), fixture-aware steps, screenshots and video.
Cypressstory.init(), story.expect, and metadata over cy.task.
RubyMinitest and RSpec, with the story object returned from init.
Go, Python, Rust, Kotlin, C#Language-native init, step methods, and raw run output per adapter.
Reporter options
Section titled “Reporter options”Vitest reporterStoryReporter options, output modes, and OpenTelemetry collection.
Jest reporterReporter entry, setup file, and output options.
Playwright reporterReporter path and options in playwright.config.ts.
Cypress reporterPlugin, support file, Mocha reporter, and the Module API.
CLI, packages, and types
Section titled “CLI, packages, and types”Formatters API and CLIEvery format, subcommand, and flag on the executable-stories binary.
Package mapWhat each published package is for, and which framework it targets.
Core types and constantsStoryMeta, StepKeyword, DocEntry, and the shared serializers.
Cross-language parityWhich guarantees every adapter makes, and where a language cannot.
Rendering and tooling
Section titled “Rendering and tooling”React rendererComponents, props, and the StoryReport contract they consume.
ThemingThe --es-* token catalog shared by the HTML report and the React renderer.
ESLint pluginsRules that catch a missing story.init or a step outside a test.