/nuxt-web-bundle

Generate web bundles with Nuxt

Primary LanguageTypeScriptMIT LicenseMIT

Nuxt Web Bundle

npm version npm downloads Github Actions Codecov

Generate web bundles with Nuxt 3

Features

⚠️ nuxt-web-bundle is an experiment. ⚠️

  • 📲 Share your website as a single file over Bluetooth.
  • ✨ Run it offline in your origin's context
  • ⚡️ Try out experimental web features.

Installation

With pnpm

pnpm add -D nuxt-web-bundle

Or, with npm

npm install -D nuxt-web-bundle

Or, with yarn

yarn add -D nuxt-web-bundle

Usage

export default defineNuxtConfig({
  modules: ['nuxt-web-bundle'],
  webBundle: {
    baseURL: 'https://my-website.com',
    // filename: 'bundle.wbn',
  },
})

That's it! Now when you run nuxi build or nuxi generate, a web bundle will be generated instead of a server or static directory.

As mentioned earlier, this is an experiment, and in order to experiment with Web Bundles, you can follow the steps here to enable usage in your version of Google Chrome.

💻 Development

  • Clone this repository
  • Enable Corepack using corepack enable
  • Install dependencies using pnpm install
  • Stub module with pnpm dev:prepare
  • Run pnpm dev to start playground in development mode

Credits

Much of the implementation is taken from rollup-plugin-webbundle - check it out and try it if you are using Vite or another Rollup-based build system.

License

Made with ❤️

Published under the MIT License.