{"id":13449480,"url":"https://github.com/vite-pwa/vitepress","last_synced_at":"2025-03-06T02:10:32.727Z","repository":{"id":59010371,"uuid":"534986065","full_name":"vite-pwa/vitepress","owner":"vite-pwa","description":"Zero-config PWA Plugin for VitePress","archived":false,"fork":false,"pushed_at":"2024-09-04T19:14:00.000Z","size":4762,"stargazers_count":41,"open_issues_count":2,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-27T01:13:43.936Z","etag":null,"topics":["pwa","vite","vite-plugin","vitepress","workbox"],"latest_commit_sha":null,"homepage":"https://vite-pwa-org.netlify.app/frameworks/vitepress","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/vite-pwa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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},"funding":{"github":"antfu","open_collective":"antfu"}},"created_at":"2022-09-10T12:05:22.000Z","updated_at":"2025-02-16T08:50:42.000Z","dependencies_parsed_at":"2023-02-18T16:32:29.179Z","dependency_job_id":"32366212-9cb6-497a-b54a-f32140ba6f62","html_url":"https://github.com/vite-pwa/vitepress","commit_stats":{"total_commits":67,"total_committers":2,"mean_commits":33.5,"dds":"0.014925373134328401","last_synced_commit":"5ee5d4d4310f4575ffe1b3ddd66e91e06a0e7025"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vite-pwa%2Fvitepress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vite-pwa%2Fvitepress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vite-pwa%2Fvitepress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vite-pwa%2Fvitepress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vite-pwa","download_url":"https://codeload.github.com/vite-pwa/vitepress/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242133524,"owners_count":20077098,"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":["pwa","vite","vite-plugin","vitepress","workbox"],"created_at":"2024-07-31T06:00:39.964Z","updated_at":"2025-03-06T02:10:32.704Z","avatar_url":"https://github.com/vite-pwa.png","language":"TypeScript","funding_links":["https://github.com/sponsors/antfu","https://opencollective.com/antfu"],"categories":[":electric_plug: Plugins"],"sub_categories":["Community Plugins"],"readme":"\u003cp align='center'\u003e\n\u003cimg src='./hero.png' alt=\"@vite-pwa/vitepress - Zero-config PWA for VitePress\"\u003e\u003cbr\u003e\nZero-config PWA Plugin for VitePress\n\u003c/p\u003e\n\n\u003cp align='center'\u003e\n\u003ca href='https://www.npmjs.com/package/@vite-pwa/vitepress' target=\"__blank\"\u003e\n\u003cimg src='https://img.shields.io/npm/v/@vite-pwa/vitepress?color=33A6B8\u0026label=' alt=\"NPM version\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://www.npmjs.com/package/@vite-pwa/vitepress\" target=\"__blank\"\u003e\n    \u003cimg alt=\"NPM Downloads\" src=\"https://img.shields.io/npm/dm/@vite-pwa/vitepress?color=476582\u0026label=\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://vite-pwa-org.netlify.app/frameworks/vitepress\" target=\"__blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/static/v1?label=\u0026message=docs%20%26%20guides\u0026color=2e859c\" alt=\"Docs \u0026 Guides\"\u003e\n\u003c/a\u003e\n\u003cbr\u003e\n\u003ca href=\"https://github.com/vite-pwa/vitepress\" target=\"__blank\"\u003e\n\u003cimg alt=\"GitHub stars\" src=\"https://img.shields.io/github/stars/vite-pwa/vitepress?style=social\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg\"\u003e\n    \u003cimg src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\n## 🚀 Features\n\n- 📖 [**Documentation \u0026 guides**](https://vite-pwa-org.netlify.app/)\n- 👌 **Zero-Config**: sensible built-in default configs for common use cases\n- 🔩 **Extensible**: expose the full ability to customize the behavior of the plugin\n- 🦾 **Type Strong**: written in [TypeScript](https://www.typescriptlang.org/)\n- 🔌 **Offline Support**: generate service worker with offline support (via Workbox)\n- ⚡ **Fully tree shakable**: auto inject Web App Manifest\n- 💬 **Prompt for new content**: built-in support for Vanilla JavaScript, Vue 3, React, Svelte, SolidJS and Preact\n- ⚙️ **Stale-while-revalidate**: automatic reload when new content is available\n- ✨ **Static assets handling**: configure static assets for offline support\n- 🐞 **Development Support**: debug your custom service worker logic as you develop your application\n- 🛠️ **Versatile**: integration with meta frameworks: [îles](https://github.com/ElMassimo/iles), [SvelteKit](https://github.com/sveltejs/kit), [VitePress](https://github.com/vuejs/vitepress), [Astro](https://github.com/withastro/astro), [Nuxt 3](https://github.com/nuxt/nuxt) and [Remix](https://github.com/remix-run/remix)\n- 💥 **PWA Assets Generator**: generate all the PWA assets from a single command and a single source image\n- 🚀 **PWA Assets Integration**: serving, generating and injecting PWA Assets on the fly in your application\n\n## 📦 Install\n\n\u003e From v0.3, `@vite-pwa/vitepress` requires **Vite 5** and **VitePress 1.0.0-rc.26 or above**.\n\n\u003e Using any version older than v0.3 requires Vite 3.1.0+.\n\n```bash\nnpm i @vite-pwa/vitepress -D \n\n# yarn \nyarn add @vite-pwa/vitepress -D\n\n# pnpm \npnpm add @vite-pwa/vitepress -D\n```\n\n## 🦄 Usage\n\nYou will need to wrap your VitePress config with `withPwa`:\n\n```ts\n// .vitepress/config.ts\nimport { defineConfig } from 'vitepress'\nimport { withPwa } from '@vite-pwa/vitepress'\n\nexport default withPwa(defineConfig({\n  /* your VitePress options */\n  /* Vite PWA Options */\n  pwa: {}\n}))\n```\n\nRead the [📖 documentation](https://vite-pwa-org.netlify.app/frameworks/vitepress) for a complete guide on how to configure and use\nthis plugin.\n\n## 👀 Full config\n\nCheck out the type declaration [src/types.ts](./src/types.ts) and the following links for more details.\n\n- [Web app manifests](https://developer.mozilla.org/en-US/docs/Web/Manifest)\n- [Workbox](https://developers.google.com/web/tools/workbox)\n\n\n## 📄 License\n\n[MIT](./LICENSE) License \u0026copy; 2022-PRESENT [Anthony Fu](https://github.com/antfu)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvite-pwa%2Fvitepress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvite-pwa%2Fvitepress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvite-pwa%2Fvitepress/lists"}