Zero-config PWA Plugin for VitePress

Vite PWA

Last update: Dec 1, 2022

Overview

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

📦 Install

npm i @vite-pwa/vitepress -D 

# yarn 
yarn add @vite-pwa/vitepress -D

# pnpm 
pnpm add @vite-pwa/vitepress -D

🦄 Usage

You will need wrap your VitePress config with withPwa:

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

📄 License

Zero Two Bot,A fully Modular Whatsapp Bot to do everything possible in WhatsApp by Team Zero Two

🍭 𝗭𝗲𝗿𝗼 𝗧𝘄𝗼 𝗠𝗗 🍭 A Moduler WhatsApp Bot designed for both PM and Groups - To take your boring WhatsApp usage into a whole different level. T

Dec 25, 2022

Multiplies a number by zero. Useful for when you need to multiply a number by zero

multiply-by-zero Multiplies a number by zero. Useful for when you need to multiply a number by zero Please consider checking out the links of this pro

Jul 3, 2022

Front-end telkom-juara pwa client

TelkomJuara This project was generated with Angular CLI version 12.2.4. Development server Run ng serve for a dev server. Navigate to http://localhost

Dec 31, 2021

simple PWA catalogue with vanilla javascript and json-server as a fake server

Mar 12, 2022

You can control the vibration capability of your device using the Vibration API. (JavaScript) This feature can useful in SPA and PWA.

Vibration Web API You can control the vibration capability of your device using the Vibration API. (JavaScript) This feature can useful in SPA and PWA

Mar 29, 2022

C'est le clone de Google où vous pouvez rechercher n'importe quoi et il affichera exactement le même résultat que nous avons utilisé l'API personnalisée de Google à travers laquelle nous avons réalisé ce projet, il est entièrement réactif et vous pouvez également l'installer en tant que PWA.

Google Clone avec Next.js C'est le clone de Google où vous pouvez rechercher n'importe quoi et il affichera exactement le même résultat que nous avons

Dec 31, 2022

Comments

check mpa

not working in pwa-prompt example, there is no client build!

EDIT: we should check if adding a custom plugin removing the ssr check (on pwa build plugin) works (it should work: we're getting the api reference using mpa flag)

opened by userquin 2
Pending
We need:

modify injectRegister to be 'virtual' | 'script' | 'inline': defaults to script?

inject webmanifest in VitePress head: we need to handle dev or build mode

inject registerSW.js or inline code to register the sw when injectRegister !== 'virtual' (if using virtual, just ignore it)

add example with prompt: requires SFC (quite simple)

enhancement
opened by userquin 2
change image title

the hero image should be for VitePress, like the title: Zero-config PWA Plugin for VitePress

@antfu do you like that change? If so, can you change/provide the hero image?

opened by userquin 1