Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Awesome Lists containing this project

README

        


@vite-pwa/vitepress - Zero-config PWA for VitePress

Zero-config PWA Plugin for VitePress



NPM version


NPM Downloads


Docs & Guides




GitHub stars






## ๐Ÿš€ 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)