HTML Webpack Plugin
Note
This is a fork of https://github.com/ampedandwired/html-webpack-plugin until https://github.com/ampedandwired/html-webpack-plugin/pull/36 is merged. I need it for work.
This is a webpack plugin that simplifies creation of HTML files to serve your webpack bundles. This is especially useful for webpack bundles that include a hash in the filename which changes every compilation. You can either let the plugin generate an HTML file for you or supply your own template (using blueimp templates).
Installation
Install the plugin with npm:
$ npm install html-webpack-plugin --save-dev
Basic Usage
The plugin will generate an HTML5 file for you that includes all your webpack
bundles in the body using script
tags. Just add the plugin to your webpack
config as follows:
var HtmlWebpackPlugin = var webpackConfig = entry: 'index.js' output: path: 'dist' filename: 'index_bundle.js' plugins:
This will generate a file dist/index.html
containing the following:
Webpack App
If you have multiple webpack entry points, they will all be included with script
tags in the generated HTML.
If you have any css assets in webpack's output (for example, css extracted
with the ExtractTextPlugin)
then these will be included with <link>
tags in the HTML head.
Icons - Favicon & Apple Touch Icon
The plugin will automatically pick up if there is a file named favicon.ico
or apple-touch-icon.png
included in the build, and automatically add them
to the HTML.
Webpack App
Configuration
You can pass a hash of configuration options to HtmlWebpackPlugin
.
Allowed values are as follows:
title
: The title to use for the generated HTML document.filename
: The file to write the HTML to. Defaults toindex.html
. You can specify a subdirectory here too (eg:assets/admin.html
).hash
: iftrue
then append a unique webpack compilation hash to all included scripts and css files. This is useful for cache busting.extraFiles
: An array of extra files, or a string with a single file, to include for easy access in a template. Note: this will only have an effect in your own templates. See example.
Here's an example webpack config illustrating how to use these options:
entry: 'index.js' output: path: 'dist' filename: 'index_bundle.js' hash: true plugins: title: 'My App' filename: 'assets/admin.html'
Generating Multiple HTML Files
To generate more than one HTML file, declare the plugin more than once in your plugins array:
entry: 'index.js' output: path: 'dist' filename: 'index_bundle.js' plugins: // Generates default index.html // Also generate a test.html filename: 'test.html' template: 'src/assets/test.html'
Writing Your Own Templates
If the default generated HTML doesn't meet your needs you can supply your own blueimp template. The default template is a good starting point for writing your own.
Let's say for example you wanted to put a webpack bundle into the head of your HTML as well as the body. Your template might look like this:
My App
To use this template, configure the plugin like this:
entry: 'index.js' output: path: 'dist' filename: 'index_bundle.js' plugins: template: 'src/assets/my_template.html'
Alternatively, if you already have your template's content in a String, you
can pass it to the plugin using the templateContent
option:
plugins: templateContent: templateContentString
The templateContent
option can also be a function to use another template language like jade:
plugins: { // Return your template content synchronously here }
Note the plugin will throw an error if you specify both template
and
templateContent
.
The o
variable in the template is the data that is passed in when the
template is rendered. This variable has the following attributes:
-
htmlWebpackPlugin
: data specific to this plugin-
htmlWebpackPlugin.files
: a massaged representation of theassetsByChunkName
attribute of webpack's stats object. It contains a mapping from entry point name to the bundle filename, eg:"htmlWebpackPlugin":If you've set a publicPath in your webpack config this will be reflected correctly in this assets hash.
-
htmlWebpackPlugin.options
: the options hash that was passed to the plugin. In addition to the options actually used by this plugin, you can use this hash to pass arbitrary data through to your template.
-
-
webpack
: the webpack stats object. Note that this is the stats object as it was at the time the HTML template was emitted and as such may not have the full set of stats that are available after the wepback run is complete. -
webpackConfig
: the webpack configuration that was used for this compilation. This can be used, for example, to get thepublicPath
(webpackConfig.output.publicPath
).
Filtering chunks
To include only certain chunks you can limit the chunks being used:
plugins: chunks: 'app'
It is also possible to exclude certain chunks by setting the excludeChunks
option:
plugins: excludeChunks: 'dev-helper'
Extra Files
To add any extra files for usage in your template, simply add them to extraFiles
. It can either be a single file, or an array of files.
plugins: extraFiles: 'cat.png' template: 'extraFiles.html'
The file will then be available in the template, under the object htmlWebpackPlugin.files.extraFiles.cat
.
The name of the object will be the filename without the extension, so watch out for collisions.
If the template looks like this:
It will result in the following output-html: