{"id":25456252,"url":"https://github.com/suiramdev/docwright","last_synced_at":"2026-04-02T02:50:04.560Z","repository":{"id":278083936,"uuid":"932205008","full_name":"suiramdev/docwright","owner":"suiramdev","description":"docwright is a library that generates UI documentation from Playwright-style test scripts. It automates the process of documenting your application's user interface.","archived":false,"fork":false,"pushed_at":"2025-02-17T22:33:16.000Z","size":45,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-02-17T23:23:25.293Z","etag":null,"topics":["automation","bun","documentation","documentation-tool","javascript","nodejs","npm","npm-package","package","playwright","tools","typescript","user-interface","vitest"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/suiramdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-13T14:42:25.000Z","updated_at":"2025-02-17T22:33:18.000Z","dependencies_parsed_at":"2025-02-17T23:23:31.596Z","dependency_job_id":null,"html_url":"https://github.com/suiramdev/docwright","commit_stats":null,"previous_names":["suiramdev/docwright"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suiramdev%2Fdocwright","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suiramdev%2Fdocwright/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suiramdev%2Fdocwright/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suiramdev%2Fdocwright/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/suiramdev","download_url":"https://codeload.github.com/suiramdev/docwright/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254573589,"owners_count":22093731,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","bun","documentation","documentation-tool","javascript","nodejs","npm","npm-package","package","playwright","tools","typescript","user-interface","vitest"],"created_at":"2025-02-18T01:29:36.168Z","updated_at":"2025-12-30T19:59:54.103Z","avatar_url":"https://github.com/suiramdev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"./docs/images/dr-wright.webp\" alt=\"docwright demo\" /\u003e\n    \u003ch1\u003edocwright\u003c/h1\u003e\n    \u003cdiv style=\"display: flex; gap: 10px; align-items: center; justify-content: center; margin: 10px 0;\"\u003e\n        \u003cimg src=\"https://img.shields.io/npm/v/@docwright/core?style=for-the-badge\" alt=\"npm version\" /\u003e\n        \u003cimg src=\"https://img.shields.io/badge/Bun-%23000000.svg?style=for-the-badge\u0026logo=bun\u0026logoColor=white\" alt=\"Bun\" /\u003e\n        \u003cimg src=\"https://img.shields.io/badge/-playwright-%232EAD33?style=for-the-badge\u0026logo=playwright\u0026logoColor=white\" alt=\"Playwright\" /\u003e\n    \u003c/div\u003e\n    \u003cp\u003e\u003cb\u003eautomate your application's UI documentation\u003c/b\u003e\u003c/p\u003e\n\u003c/div\u003e\n\ndocwright is a library that generates UI documentation from Playwright-style test scripts. It automates the process of documenting your application's user interface.\n\n[Read API](./docs/api.md)\n\n## Quick Start\n\n1. **Install docwright**\n\n   ```bash\n   bun install @docwright/core\n   ```\n\n   \u003e Due to Node.js's limitations, docwright currently only works with Bun. [Read more](#technical-details)\n\n2. **Create a `docwright.config.ts` file.**\n\n   ```bash\n   bunx docwright init\n   ```\n\n   [Example `docwright.config.ts`](./playground/docwright.config.ts)\n\n3. **Run docwright**\n\n   ```bash\n   bunx docwright generate\n   ```\n\n### Create your first scenario\n\nCreate a file matching your docwright.config.ts glob pattern.\n\nExample: [portfolio.docwright.ts](./playground/portfolio.docwright.ts)\n\n```typescript\nimport {\n  describe,\n  scenario,\n  text,\n  screenshot,\n  highlight,\n} from \"@docwright/core\";\n\ndescribe(\"suiram.dev portfolio\", () =\u003e {\n  scenario(\"How to book a call\", async ({ page }) =\u003e {\n    await text(\"Navigate to https://suiram.dev\");\n    await page.goto(\"https://suiram.dev\");\n    await text(\"Click the book a call button\");\n    await highlight(\n      page.locator(\"a[href='https://calcom.suiram.dev/suiramdev/30min']\")\n    );\n    await screenshot(page);\n  });\n});\n```\n\n## Credits\n\nThanks to:\n\n- [@yanndarwish](https://github.com/yanndarwish)\n- [@aziv7](https://github.com/aziv7)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuiramdev%2Fdocwright","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuiramdev%2Fdocwright","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuiramdev%2Fdocwright/lists"}