Skip to main content


About 2 min


  • Type: ManifestOption
  • Required: No

You can fill with an object which will be parsed to manifest.webmanifest.


Some options have their fallback if you don't set them.

  • name: siteConfig.title || siteConfig.locales['/'].title || "Site"

  • short_name: siteConfig.title || siteConfig.locales['/'].title || "Site"

  • description: siteConfig.description || siteConfig.locales['/'].description || "A site built with vuepress"

  • lang: siteConfig.locales['/'].lang || "en-US"

  • start_url: context.base

  • scope: context.base

  • display: "standalone"

  • theme_color: "#46bd87"

  • background_color: "#ffffff"

  • orientation: "portrait-primary"

  • prefer_related_applications: false


For docs of Manifest, please see W3C Manifestopen in new window


  • Type: string
  • Required: No

Path of favicon.ico with absolute path.


We recommend you to set favicon for your site


  • 类型: string
  • 默认值: "#46bd87"

Theme Color, default is theme green


  • Type: number
  • Default: 2048

Max size allowed to be cached, with KB unit


This option has the highest priority, and any files exceeding this value will be excluded.

So if you generate very large HTML or JS files, please consider increasing this value, otherwise your PWA may not work normally in offline mode.


  • Type: boolean
  • Default: false

Whether cache HTML files besides home page and 404 page.


  • Type: boolean
  • Default: false

Whether cache pictures


  • Type: number
  • Default: 1024

Max picture size allowed to be cached, with KB unit


  • Type: "disabled" | "available" | "hint" | "force"
  • Default: "available"

Control logic when new content is found.

  • "disabled": Do nothing even when new service worker is available. After new service work succeeds installing and starts waiting, it will control page and provide new content in next visit.

  • "available": Only display update popup when the new service worker is available

  • "hint": Display a hint to let user choose to refresh immediately

    This is helpful when you want users to see new docs immediately.


    If users choose to refresh, the current service worker will be unregister, and request will start coming to web. Later the new service worker will start installing and control current page after installed.

  • "force": unregister current service worker immediately then refresh to get new content


    Although this ensures users are viewing the latest content, it may affect viewing experiences.


How docs are updated is controlled by a previous version, so the current option only effect next update from this version.


Special settings for Apple

If you don't want to make detailed settings, you can safely ignore it; if you don't want your site compatible with safari on apple, please set it to false.


  • Type: string
  • Required: No

Fill in the icon address used by Apple, the recommended size is 152×152


  • Type: "black" | "white"
  • Default: "black"

Apple's status bar color


  • Type: string
  • Required: No

Safari mask icon


Special settings for Microsoft tiles

If you don't want to make detailed settings, you can safely ignore it; if you don't want your site compatible with windows, please set it to false.


  • Type: string
  • Required: No

Tile icon


  • Type: string
  • Default value: themeColor

The tile color will automatically fall back to themeColor if you don't set it.


  • Type: string
  • Default: "SWHintPopup"

You can fill in the custom hint popup component path.


  • Type: string
  • Default: "SWUpdatePopup"

You can fill in the custom update popup component path.


  • Type: boolean
  • Default: false

Whether append base to all absolute links.


Options passed to workbox-build, for details, see Workbox documentationopen in new window


  • Type: PWALocaleConfig

    interface PWALocaleData {
       * Install button text
      install: string;
       * iOS install hint text
      iOSInstall: string;
       * Cancel button text
      cancel: string;
       * Close button text
      close: string;
       * Previous image text
      prevImage: string;
       * Next image text
      nextImage: string;
       * Install explain text
      explain: string;
       * Description label text
      desc: string;
       * Feature label text
      feature: string;
       * Update hint text
      hint: string;
       * Update available text
      update: string;
    interface PWALocaleConfig {
      [localePath: string]: PWALocaleData;
  • Required: No

Locales config for pwa plugin.

Built-in Supported Languages
  • Simplified Chinese (zh-CN)
  • Traditional Chinese (zh-TW)
  • English (United States) (en-US)
  • German (de-DE)
  • German (Australia) (de-AT)
  • Russian (ru-RU)
  • Ukrainian (uk-UA)
  • Vietnamese (vi-VN)
  • Portuguese (Brazil) (pt-BR)
  • Polish (pl-PL)
  • French (fr-FR)
  • Spanish (es-ES)
  • Slovak (sk-SK)
  • Japanese (ja-JP)
  • Turkish (tr-TR)
  • Korean (ko-KR)
  • Finnish (fi-FI)
  • Indonesian (id-ID)
  • Dutch (nl-NL)