Zero-config PWA Plugin for VitePress

🚀 Features

- 📖 Documentation & guides
- 👌 Zero-Config: sensible built-in default configs for common use cases
- 🔩 Extensible: expose the full ability to customize the behavior of the plugin
- 🦾 Type Strong: written in TypeScript
- 🔌 Offline Support: generate service worker with offline support (via Workbox)
- ⚡ Fully tree shakable: auto inject Web App Manifest
- 💬 Prompt for new content: built-in support for Vanilla JavaScript, Vue 3, React, Svelte, SolidJS and Preact
- ⚙️ Stale-while-revalidate: automatic reload when new content is available
- ✨ Static assets handling: configure static assets for offline support
- 🐞 Development Support: debug your custom service worker logic as you develop your application
- 🛠️ Versatile: integration with meta frameworks: îles, SvelteKit, VitePress, Astro, Nuxt 3 and Remix
- 💥 PWA Assets Generator: generate all the PWA assets from a single command and a single source image
- 🚀 PWA Assets Integration: serving, generating and injecting PWA Assets on the fly in your application

📦 Install

> From v0.3, @vite-pwa/vitepress requires Vite 5 and VitePress 1.0.0-rc.26 or above.

> Using any version older than v0.3 requires Vite 3.1.0+.

``bash
npm i @vite-pwa/vitepress -D

yarn

yarn add @vite-pwa/vitepress -D

pnpm

pnpm add @vite-pwa/vitepress -D
`

🦄 Usage

You will need to wrap your VitePress config with withPwa:

`ts
// .vitepress/config.ts
import { withPwa } from '@vite-pwa/vitepress'
import { defineConfig } from 'vitepress'

export default withPwa(defineConfig({
/ your VitePress options /
/ Vite PWA Options /
pwa: {}
}))
``

Read the 📖 documentation for a complete guide on how to configure and use
this plugin.

👀 Full config

Check out the type declaration src/types.ts and the following links for more details.

- Web app manifests
- Workbox

📄 License

MIT License © 2022-PRESENT Anthony Fu