livedoc

LiveDoc is a living documentation platform that lets teams write executable specifications using Gherkin-style Given/When/Then syntax directly inside their existing test frameworks. Rather than maintaining separate feature files, the specifications live in the test code and double as documentation. What it provides: - Gherkin syntax support for Vitest (TypeScript/JavaScript) via @swedevtools/livedoc-vitest, and for xUnit (.NET) via SweDevTools.LiveDoc.xUnit. - A real-time web UI viewer (@swedevtools/livedoc-viewer) that displays test results as they run, with a published live example linked from the README. - A VS Code extension (livedoc-vscode) offering snippets and formatting for the BDD syntax. - Data tables and scenario outlines for data-driven testing. - Tag filtering to include or exclude tests by tag. - Formatted, colored terminal output for test results. Setup paths: - TypeScript: install vitest and @swedevtools/livedoc-vitest as dev dependencies, then import feature, scenario, given, when and then helpers to structure tests. - C#: add the SweDevTools.LiveDoc.xUnit package and derive test classes from FeatureTest, using [Feature] and [Scenario] attributes plus Given/When/Then methods. - The README also describes an AI-assisted setup flow where a coding assistant reads a hosted setup guide and configures the repository, asking configuration questions one at a time before making changes. Two workspace packages, @swedevtools/livedoc-schema and @swedevtools/livedoc-server, are private and embedded in the viewer distribution rather than published independently. The project is MIT licensed and requires Node.js 18+ and .NET 8.0 for the respective stacks.