@vite-pwa/vitepress 1.0.0 → 1.1.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022-PRESENT Anthony Fu <https://github.com/antfu>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022-PRESENT Anthony Fu <https://github.com/antfu>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,90 +1,90 @@
-<p align='center'>
-<img src='./hero.png' alt="@vite-pwa/vitepress - Zero-config PWA for VitePress"><br>
-Zero-config PWA Plugin for VitePress
-</p>
-
-<p align='center'>
-<a href='https://www.npmjs.com/package/@vite-pwa/vitepress' target="__blank">
-<img src='https://img.shields.io/npm/v/@vite-pwa/vitepress?color=33A6B8&label=' alt="NPM version">
-</a>
-<a href="https://www.npmjs.com/package/@vite-pwa/vitepress" target="__blank">
-    <img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@vite-pwa/vitepress?color=476582&label=">
-</a>
-<a href="https://vite-pwa-org.netlify.app/frameworks/vitepress" target="__blank">
-    <img src="https://img.shields.io/static/v1?label=&message=docs%20%26%20guides&color=2e859c" alt="Docs & Guides">
-</a>
-<br>
-<a href="https://github.com/vite-pwa/vitepress" target="__blank">
-<img alt="GitHub stars" src="https://img.shields.io/github/stars/vite-pwa/vitepress?style=social">
-</a>
-</p>
-
-<br>
-
-<p align="center">
-  <a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg">
-    <img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/>
-  </a>
-</p>
-
-## 🚀 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 { withPwa } from '@vite-pwa/vitepress'
-import { defineConfig } from '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 &copy; 2022-PRESENT [Anthony Fu](https://github.com/antfu)
+<p align='center'>
+<img src='./hero.png' alt="@vite-pwa/vitepress - Zero-config PWA for VitePress"><br>
+Zero-config PWA Plugin for VitePress
+</p>
+
+<p align='center'>
+<a href='https://www.npmjs.com/package/@vite-pwa/vitepress' target="__blank">
+<img src='https://img.shields.io/npm/v/@vite-pwa/vitepress?color=33A6B8&label=' alt="NPM version">
+</a>
+<a href="https://www.npmjs.com/package/@vite-pwa/vitepress" target="__blank">
+    <img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@vite-pwa/vitepress?color=476582&label=">
+</a>
+<a href="https://vite-pwa-org.netlify.app/frameworks/vitepress" target="__blank">
+    <img src="https://img.shields.io/static/v1?label=&message=docs%20%26%20guides&color=2e859c" alt="Docs & Guides">
+</a>
+<br>
+<a href="https://github.com/vite-pwa/vitepress" target="__blank">
+<img alt="GitHub stars" src="https://img.shields.io/github/stars/vite-pwa/vitepress?style=social">
+</a>
+</p>
+
+<br>
+
+<p align="center">
+  <a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg">
+    <img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/>
+  </a>
+</p>
+
+## 🚀 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 { withPwa } from '@vite-pwa/vitepress'
+import { defineConfig } from '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 &copy; 2022-PRESENT [Anthony Fu](https://github.com/antfu)

package/index.d.ts

@@ -1 +1 @@
-export * from './dist'
+export * from './dist'

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@vite-pwa/vitepress",
   "type": "module",
-  "version": "1.0.0",
-  "packageManager": "pnpm@10.7.0",
+  "version": "1.1.0",
   "description": "Zero-config PWA for VitePress",
   "author": "antfu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -35,16 +34,9 @@
     "*.d.ts",
     "dist"
   ],
-  "scripts": {
-    "build": "unbuild",
-    "lint": "eslint .",
-    "lint:fix": "nr lint --fix",
-    "prepublishOnly": "npm run build",
-    "release": "bumpp && npm publish"
-  },
   "peerDependencies": {
     "@vite-pwa/assets-generator": "^1.0.0",
-    "vite-plugin-pwa": "^1.0.0"
+    "vite-plugin-pwa": "^1.2.0"
   },
   "peerDependenciesMeta": {
     "@vite-pwa/assets-generator": {
@@ -63,21 +55,13 @@
     "typescript": "^5.4.5",
     "unbuild": "^2.0.0",
     "vite": "^5.2.10",
-    "vite-plugin-pwa": "^1.0.0",
+    "vite-plugin-pwa": "^1.2.0",
     "vitepress": "^1.1.4"
   },
-  "pnpm": {
-    "peerDependencyRules": {
-      "ignoreMissing": [
-        "@algolia/client-search"
-      ]
-    },
-    "ignoredBuiltDependencies": [
-      "esbuild",
-      "vue-demi"
-    ],
-    "onlyBuiltDependencies": [
-      "sharp"
-    ]
+  "scripts": {
+    "build": "unbuild",
+    "lint": "eslint .",
+    "lint:fix": "nr lint --fix",
+    "release": "bumpp"
   }
-}
+}