Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vite-pwa/vitepress
Zero-config PWA Plugin for VitePress
https://github.com/vite-pwa/vitepress
pwa vite vite-plugin vitepress workbox
Last synced: 5 days ago
JSON representation
Zero-config PWA Plugin for VitePress
- Host: GitHub
- URL: https://github.com/vite-pwa/vitepress
- Owner: vite-pwa
- License: mit
- Created: 2022-09-10T12:05:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-04T19:14:00.000Z (5 months ago)
- Last Synced: 2025-01-14T02:07:57.685Z (12 days ago)
- Topics: pwa, vite, vite-plugin, vitepress, workbox
- Language: TypeScript
- Homepage: https://vite-pwa-org.netlify.app/frameworks/vitepress
- Size: 4.54 MB
- Stars: 40
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-vitepress-v1 - PWA - Zero-config PWA Plugin for VitePress (:electric_plug: Plugins / Community Plugins)
README
Zero-config PWA Plugin for VitePress
## ๐ Features
- ๐ [**Documentation & guides**](https://vite-pwa-org.netlify.app/)
- ๐ **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](https://www.typescriptlang.org/)
- ๐ **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](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)
- ๐ฅ **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 { defineConfig } from 'vitepress'
import { withPwa } from '@vite-pwa/vitepress'export default withPwa(defineConfig({
/* your VitePress options */
/* Vite PWA Options */
pwa: {}
}))
```Read the [๐ documentation](https://vite-pwa-org.netlify.app/frameworks/vitepress) for a complete guide on how to configure and use
this plugin.## ๐ Full config
Check out the type declaration [src/types.ts](./src/types.ts) and the following links for more details.
- [Web app manifests](https://developer.mozilla.org/en-US/docs/Web/Manifest)
- [Workbox](https://developers.google.com/web/tools/workbox)## ๐ License
[MIT](./LICENSE) License ยฉ 2022-PRESENT [Anthony Fu](https://github.com/antfu)