DOCUMENTATION

Welcome to the functional-examples documentation. Browse the sections below to learn about configuration, plugins, scanning, and more.

PLUGINS

Extract examples from TypeScript and JavaScript files using frontmatter metadata and region markers.

Discover multi-file examples using meta.yml manifest files with directory-based organization.

Define and run executable tests for your examples with assertions for exit codes, output, files, and snapshots.

Generate markdown documentation from scanned examples with templates, prose helpers, and guide rendering.

Install functional-examples, configure your first project, and run your first scan.

The problem functional-examples solves, its design philosophy, and how it treats examples as first-class project artifacts.

Understand examples, extractors, plugins, configuration, regions, and the scanner pipeline.

Built-in plugins, when to use each one, multi-plugin setups, and building custom extractors.

TypeScript vs JSON config, scan patterns, metadata schemas, and path mappings.

Use the test plugin to verify examples run correctly, define assertions, and integrate with CI.

Real-world scenarios where functional-examples shines: doc sites, tutorials, API references, monorepos, and OSS showcases.

Build custom extractors to support alternative metadata formats like TOML, INI, or any structured file.

Build complete plugins with extractors, parsers, validators, schemas, and CLI commands.

Use snapshot assertions to verify example output against stored reference files.

Run example tests in GitHub Actions and other CI pipelines with TAP reporting and snapshot management.