Not a Propaganda Machine

    @piraces/eleventy-plugin-pwa

    1.1.2 • Public • Published

    @piraces/eleventy-plugin-pwa

    license: MIT eleventy code style: prettier codecov

    An Eleventy plugin to generate service worker. Using Google Workbox to generate service-worker.js based on your dir.output.

    Note

    This is a fork of the original work of @okitavera in eleventy-plugin-pwa, providing up-to-date support with the latest versions of Workbox, Eleventy and other related dependencies (in order to use the latest features and advancements of these tools).

    Installation

    npm i @piraces/eleventy-plugin-pwa

    Add to eleventy config file

    const pluginPWA = require("@piraces/eleventy-plugin-pwa");
    module.exports = function(eleventyConfig) {
      eleventyConfig.addPlugin(pluginPWA);
    };

    Read more about Eleventy plugins

    Registering Service Worker

    // in your header templates
    <script>
      if ("serviceWorker" in navigator)
        navigator.serviceWorker.register("/service-worker.js");
    </script>

    Adding Web App Manifest

    Read The Web App Manifest Guide

    Options

    You can also pass workbox generateSW options directly into the plugin. For example :

    // overwriting destination file and more
    const pluginPWA = require("@piraces/eleventy-plugin-pwa");
    module.exports = function(eleventyConfig) {
      eleventyConfig.addPlugin(pluginPWA, {
        swDest: "./build/sw.js",
        globDirectory: "./build"
      });
    };

    Read more about it on workbox generateSW module page

    License

    This code is available under the MIT license.

    Install

    npm i @piraces/eleventy-plugin-pwa

    DownloadsWeekly Downloads

    50

    Version

    1.1.2

    License

    MIT

    Unpacked Size

    11.3 kB

    Total Files

    13

    Last publish

    Collaborators

    • piraces