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+.

1npm i @vite-pwa/vitepress -D
2
3# yarn
4yarn add @vite-pwa/vitepress -D
5
6# pnpm
7pnpm add @vite-pwa/vitepress -D

🦄 Usage

You will need to wrap your VitePress config with withPwa:

1// .vitepress/config.ts
2import { withPwa } from '@vite-pwa/vitepress'
3import { defineConfig } from 'vitepress'
4
5export default withPwa(defineConfig({
6  /* your VitePress options */
7  /* Vite PWA Options */
8  pwa: {}
9}))

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