docwright is a library that generates UI documentation from Playwright-style test scripts. It automates the process of documenting your application's user interface.
-
Install docwright
bun install @docwright/core
Due to Node.js's limitations, docwright currently only works with Bun. Read more
-
Create a
docwright.config.tsfile.bunx docwright init
-
Run docwright
bunx docwright generate
Create a file matching your docwright.config.ts glob pattern.
Example: portfolio.docwright.ts
import { describe, scenario, text, screenshot, highlight, } from "@docwright/core"; describe("suiram.dev portfolio", () => { scenario("How to book a call", async ({ page }) => { await text("Navigate to https://suiram.dev"); await page.goto("https://suiram.dev"); await text("Click the book a call button"); await highlight( page.locator("a[href='https://calcom.suiram.dev/suiramdev/30min']") ); await screenshot(page); }); });
Thanks to: