Grunt task for generating an HTML5 AppCache manifest.
Grunt task for generating an HTML5 AppCache manifest from the specified list of files.
This plugin requires Grunt
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-appcache --save-dev
In your project's Gruntfile, add a section named
appcache to the data object passed into
gruntinitConfigappcache:options:// Task-specific options go here.your_target:// Target-specific file lists and/or options go here.
The absolute or relative path to the directory to consider as the root of the application for which to generate the cache manifest.
The base URL to prepand to all expanded cache entries.
Specifies if to ignore the cache manifest itself from the list of files to insert in the "CACHE:" section.
Specifies whether to write the "prefer-online" entry in the "SETTINGS:" section or not. More information.
String indicating the output path for the AppCache manifest.
A descriptor for the "CACHE:" entries. A cache descriptor can be either a
String or an
Strings, in the format accepted by the
patterns argument to grunt.file.expand.
Alternatively, this argument can be an
Object containing the optional properties
patterns (a cache descriptor, as defined earlier) and
Strings to insert as is in the "CACHE:" section).
Files to be ignored and excluded from the "CACHE:" entries. This parameter has been deprecated since v0.1.4, when proper support for the
! prefix to the glob patterns was added (this serves the same purpose while being more concise).
Strings to insert as is in the "NETWORK:" section.
Strings to insert as is in the "FALLBACK:" section.
In this example, the module is set to generate an AppCache manifest from the contents of the
static directory, placing the resulting manifest in
basePath option allows the module to generate paths relative to the
static directory, instead of the directory where the gruntfile resides.
gruntinitConfigappcache:options:basePath: 'static'all:dest: 'static/manifest.appcache'cache: 'static/**/*'network: '*'fallback: '/ /offline.html'
The next example uses the extended syntax to the
gruntinitConfigappcache:options:basePath: 'static'all:dest: 'static/manifest.appcache'cache:patterns:'static/**/*' // all the resources in 'static/''!static/ignored/**/*' // except the 'static/ignored/' subtreeliterals: '/' // insert '/' as is in the "CACHE:" section