{"id":13880823,"url":"https://github.com/fwouts/viteshot","last_synced_at":"2025-08-19T22:32:19.930Z","repository":{"id":45466757,"uuid":"380415792","full_name":"fwouts/viteshot","owner":"fwouts","description":"Viteshot 📸 is a fast and simple component screenshot tool based on Vite.","archived":false,"fork":false,"pushed_at":"2023-04-10T23:33:40.000Z","size":10609,"stargazers_count":215,"open_issues_count":15,"forks_count":12,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-09T17:58:06.671Z","etag":null,"topics":["javascript","preact","react","screenshot","solid-js","svelte","vue"],"latest_commit_sha":null,"homepage":"https://viteshot.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fwouts.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"fwouts"}},"created_at":"2021-06-26T04:49:44.000Z","updated_at":"2024-12-05T15:21:55.000Z","dependencies_parsed_at":"2024-01-13T20:58:43.881Z","dependency_job_id":"4179a0d7-bd17-40c5-9cbd-a612b01e69a1","html_url":"https://github.com/fwouts/viteshot","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fwouts%2Fviteshot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fwouts%2Fviteshot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fwouts%2Fviteshot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fwouts%2Fviteshot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fwouts","download_url":"https://codeload.github.com/fwouts/viteshot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230374118,"owners_count":18216041,"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":["javascript","preact","react","screenshot","solid-js","svelte","vue"],"created_at":"2024-08-06T08:03:31.135Z","updated_at":"2024-12-19T04:07:04.846Z","avatar_url":"https://github.com/fwouts.png","language":"TypeScript","funding_links":["https://github.com/sponsors/fwouts"],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003e **Warning**\n\u003e\n\u003e This package is no longer actively maintained.\n\u003e\n\u003e Check out [@previewjs/screenshot](https://github.com/fwouts/previewjs/tree/main/screenshot) for an alternative.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/zenclabs/viteshot/main/docs/static/img/logo.png\" alt=\"logo\" width=\"200\" /\u003e\n\u003c/p\u003e\n\u003cbr/\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/viteshot\"\u003e\n    \u003cimg src=\"https://badge.fury.io/js/viteshot.svg\" alt=\"npm\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/viteshot\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/l/viteshot.svg\" alt=\"license\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003cbr /\u003e\n\n# ViteShot 📸\n\nViteShot is a fast and simple component screenshot tool based on [Vite](https://vitejs.dev).\n\nIt supports Preact, React, Solid, Svelte and Vue 3.\n\n![Gif preview](viteshot.gif)\n\n## Installation\n\n```sh\n\n# Install ViteShot.\nnpm install --save-dev viteshot # NPM\nyarn add -D viteshot # Yarn\npnpm add -D viteshot # PNPM\n\n# Set up ViteShot configuration in your repository.\nviteshot init\n```\n\n## Getting Started\n\nPlease refer to the [documentation](https://viteshot.com/docs/getting-started) for more information.\n\n## Examples\n\nAll you need is to export UI components from files with the `.screenshot.jsx/tsx/vue/svelte` extension.\n\nSee examples:\n\n- [Preact](https://github.com/zenclabs/viteshot/blob/main/examples/preact/src/App.screenshot.tsx)\n- [React](https://github.com/zenclabs/viteshot/blob/main/examples/react-tsx/src/App.screenshot.tsx)\n- [Solid](https://github.com/zenclabs/viteshot/blob/main/examples/solid/src/App.screenshot.tsx)\n- [Svelte](https://github.com/zenclabs/viteshot/blob/main/examples/svelte/src/lib/Counter.screenshot.svelte)\n- [Vue](https://github.com/zenclabs/viteshot/blob/main/examples/vue/src/components/HelloWorld.screenshot.vue)\n\nThen, generate screenshots with:\n\n```sh\n# Take screenshots.\nviteshot\n\u003e Capturing: src/__screenshots__/darwin/pixel2/App-App.png\n\u003e Capturing: src/__screenshots__/darwin/laptop/App-App.png\n\u003e Capturing: src/__screenshots__/darwin/pixel2/App-Clicked.png\n\u003e Capturing: src/__screenshots__/darwin/laptop/App-Clicked.png\n\u003e Capturing: src/__screenshots__/darwin/pixel2/App-Greet.png\n\u003e Capturing: src/__screenshots__/darwin/laptop/App-Greet.png\n\u003e Capturing: src/__screenshots__/darwin/laptop/App-HelloWorld.png\n\u003e Capturing: src/__screenshots__/darwin/pixel2/App-HelloWorld.png\n\u003e All done.\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffwouts%2Fviteshot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffwouts%2Fviteshot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffwouts%2Fviteshot/lists"}