https://github.com/lavas-project/hexo-pwa

Hexo PWA plugin
https://github.com/lavas-project/hexo-pwa

hexo hexo-plugin pwa service-worker

Last synced: 3 months ago
JSON representation

Hexo PWA plugin

• Host: GitHub
• URL: https://github.com/lavas-project/hexo-pwa
• Owner: lavas-project
• License: mit
• Created: 2017-11-06T06:23:18.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-06-14T09:54:50.000Z (over 3 years ago)
• Last Synced: 2024-09-26T09:13:16.173Z (4 months ago)
• Topics: hexo, hexo-plugin, pwa, service-worker
• Language: JavaScript
• Homepage:
• Size: 35.2 KB
• Stars: 133
• Watchers: 5
• Forks: 17
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hexo-pwa

[![NPM version](https://badge.fury.io/js/hexo-pwa.svg)](http://badge.fury.io/js/hexo-pwa) [![NPM Downloads](https://img.shields.io/npm/dm/hexo-pwa.svg?maxAge=3600)](https://www.npmjs.com/package/hexo-pwa)

Progressive Web Apps (PWA) plugin for [Hexo](https://hexo.io/).

`hexo-pwa` let Hexo sites have these two  capabilities.

- [Web App Manifest](https://developer.mozilla.org/en-US/docs/Web/Manifest) - Users can add your site to mobile home screen

- [Service Worker](https://developers.google.com/web/fundamentals/primers/service-workers/) - Make your site available offline

## Installation

```shell

$ npm install --save hexo-pwa

```

## Options

You can configure this plugin in `_config.yml`.

```yaml

pwa:

  manifest:

    path: /manifest.json

    body:

      name: hexo

      short_name: hexo

      icons:

        - src: /images/android-chrome-192x192.png

          sizes: 192x192

          type: image/png

        - src: /images/android-chrome-512x512.png

          sizes: 512x512

          type: image/png

      start_url: /index.html

      theme_color: '#ffffff'

      background_color: '#ffffff'

      display: standalone

  serviceWorker:

    path: /sw.js

    preload:

      urls:

        - /

      posts: 5

    opts:

      networkTimeoutSeconds: 5

    routes:

      - pattern: !!js/regexp /hm.baidu.com/

        strategy: networkOnly

      - pattern: !!js/regexp /.*\.(js|css|jpg|jpeg|png|gif)$/

        strategy: cacheFirst

      - pattern: !!js/regexp /\//

        strategy: networkFirst

  priority: 5

```

- manifest - manifest configuration

	- path - the path of `manifest.json`, eg: `/manifest.json`

	- body - the content of `manifest.json`,  [manifest.json example](https://developer.mozilla.org/en-US/docs/Web/Manifest). `body` can be null, if not null, `hexo-pwa` will generate `manifest.json` with `JSON.stringify(body)`

- serviceWorker - service worker configuration

	- path: the path of `sw.js`, eg: `/sw.js`, you shouldn't put sw.js in subdirectory because of the [service worker scope](https://developers.google.com/web/ilt/pwa/introduction-to-service-worker#registration_and_scope)

	- preload - urls or posts that you want to preload

		- urls: an array of the preload urls

		- posts: the count of preload posts

    - opts: the options for [sw-toolbox](https://googlechromelabs.github.io/sw-toolbox/api.html#options)

	- routes - request routes and strategies, based on [sw-toolbox](https://googlechromelabs.github.io/sw-toolbox/#main). **The routes order does matter**.

		- pattern: url pattern, this config can be express-style or RegExp

		- strategy: the strategy you want to choose. [All strategies](https://googlechromelabs.github.io/sw-toolbox/api.html#options): `cacheFirst`, `networkFirst`, `cacheOnly`, `networkOnly`, `fastest`. Caution: Log requests should use `networkOnly` strategy.

- priority - [plugin priority](https://hexo.io/api/filter.html) (default value is 10)

## License

MIT