[![npm][npm]][npm-url]
[![node][node]][node-url]
!npm
[![deps][deps]][deps-url]
[![tests][tests]][tests-url]

src="https://webpack.js.org/assets/icon-square-big.svg">

HTML Webpack Plugin

Plugin that simplifies creation of HTML files to serve your bundles

Install Beta

``bash
npm i --save-dev html-webpack-plugin@next
`

`bash
yarn add --dev html-webpack-plugin@next
`

Install Stable

`bash
npm i --save-dev html-webpack-plugin
`

`bash
yarn add --dev html-webpack-plugin
`


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, supply
your own template using lodash templates or use your own loader.

Sponsors

Thanks for supporting the ongoing improvements to the html-webpack-plugin!

Zero Config

The html-webpack-plugin works without configuration.
It's a great addition to the ⚙️ webpack-config-plugins.

Plugins

The html-webpack-plugin provides hooks to extend it to your needs. There are already some really powerful plugins which can be integrated with zero configuration

* webpack-subresource-integrity for enhanced asset security
* appcache-webpack-plugin for iOS and Android offline usage
* favicons-webpack-plugin which generates favicons and icons for iOS, Android and desktop browsers
* html-webpack-harddisk-plugin can be used to always write to disk the html file, useful when webpack-dev-server / HMR are being used
* html-webpack-inline-source-plugin to inline your assets in the resulting HTML file
* html-webpack-inline-svg-plugin to inline SVGs in the resulting HTML file.
* html-webpack-exclude-assets-plugin for excluding assets using regular expressions
* html-webpack-include-assets-plugin for including lists of js or css file paths (such as those copied by the copy-webpack-plugin).
* script-ext-html-webpack-plugin to add async, defer or module attributes to your


`

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 mini-css-extract-plugin)
then these will be included with tags in the HTML head.

If you have plugins that make use of it, html-webpack-plugin should be ordered first before any of the integrated plugins.

Options

You can pass a hash of configuration options to html-webpack-plugin.
Allowed values are as follows

|Name|Type|Default|Description|
|:--:|:--:|:-----:|:----------|
|title|{String}|Webpack App|The title to use for the generated HTML document|
|filename|{String}|'index.html'|The file to write the HTML to. Defaults to index.html. You can specify a subdirectory here too (eg: assets/admin.html)|
|template|{String}||webpack relative or absolute path to the template. By default it will use src/index.ejs if it exists. Please see the docs for details|
|templateParameters|{Boolean\|Object\|Function}|| Allows to overwrite the parameters used in the template - see example |
|inject|{Boolean\|String}|true|true \|\| 'head' \|\| 'body' \|\| false Inject all assets into the given template or templateContent. When passing true or 'body' all javascript resources will be placed at the bottom of the body element. 'head' will place the scripts in the head element - see the inject:false example|
|favicon|{String}||Adds the given favicon path to the output HTML|
|meta|{Object}|{}|Allows to inject meta-tags. E.g. meta: {viewport: 'width=device-width, initial-scale=1, shrink-to-fit=no'}|
|base|{Object\|String\|false}|false|Inject a base tag. E.g. base: "https://example.com/path/page.html|
|minify|{Boolean\|Object}|true if mode is 'production', otherwise false|Controls if and in what ways the output should be minified. See minification below for more details.|
|hash|{Boolean}|false|If true then append a unique webpack compilation hash to all included scripts and CSS files. This is useful for cache busting|
|cache|{Boolean}|true|Emit the file only if it was changed|
|showErrors|{Boolean}|true|Errors details will be written into the HTML page|
|chunks|{?}|?|Allows you to add only some chunks (e.g only the unit-test chunk)|
|chunksSortMode|{String\|Function}|auto|Allows to control how chunks should be sorted before they are included to the HTML. Allowed values are 'none' \| 'auto' \| 'dependency' \| 'manual' \| {Function}|
|excludeChunks|{Array.}||Allows you to skip some chunks (e.g don't add the unit-test chunk)|
|xhtml|{Boolean}|false|If true render the link tags as self-closing (XHTML compliant)|

Here's an example webpack config illustrating how to use these options

webpack.config.js
`js
{
entry: 'index.js',
output: {
path: __dirname + '/dist',
filename: 'index_bundle.js'
},
plugins: [
new HtmlWebpackPlugin({
title: 'My App',
filename: 'assets/admin.html'
})
]
}
`

$3

To generate more than one HTML file, declare the plugin more than
once in your plugins array

webpack.config.js
`js
{
entry: 'index.js',
output: {
path: __dirname + '/dist',
filename: 'index_bundle.js'
},
plugins: [
new HtmlWebpackPlugin(), // Generates default index.html
new HtmlWebpackPlugin({ // Also generate a test.html
filename: 'test.html',
template: 'src/assets/test.html'
})
]
}
`

$3

If the default generated HTML doesn't meet your needs you can supply
your own template. The easiest way is to use the template option and pass a custom HTML file.
The html-webpack-plugin will automatically inject all necessary CSS, JS, manifest
and favicon files into the markup.

Details of other template loaders are documented here.

`js
plugins: [
new HtmlWebpackPlugin({
title: 'Custom template',
// Load a custom template (lodash by default)
template: 'index.html'
})
]
`

index.html
`html









`

If you already have a template loader, you can use it to parse the template.
Please note that this will also happen if you specify the html-loader and use .html file as template.

webpack.config.js
`js
module: {
loaders: [
{ test: /\.hbs$/, loader: "handlebars-loader" }
]
},
plugins: [
new HtmlWebpackPlugin({
title: 'Custom template using Handlebars',
template: 'index.hbs'
})
]
`

You can use the lodash syntax out of the box. If the inject feature doesn't fit your needs and you want full control over the asset placement use the default template of the html-webpack-template project as a starting point for writing your own.

The following variables are available in the template:
- htmlWebpackPlugin: data specific to this plugin
- htmlWebpackPlugin.files: a massaged representation of the
assetsByChunkName attribute of webpack's stats
object. It contains a mapping from entry point name to the bundle filename, eg:
`json
"htmlWebpackPlugin": {
"files": {
"css": [ "main.css" ],
"js": [ "assets/head_bundle.js", "assets/main_bundle.js"],
"chunks": {
"head": {
"entry": "assets/head_bundle.js",
"css": [ "main.css" ]
},
"main": {
"entry": "assets/main_bundle.js",
"css": []
},
}
}
}
`
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 webpack run is complete.

- webpackConfig: the webpack configuration that was used for this compilation. This
can be used, for example, to get the publicPath (webpackConfig.output.publicPath).

- compilation: the webpack compilation object.
This can be used, for example, to get the contents of processed assets and inline them
directly in the page, through compilation.assets[...].source()
(see the inline template example).

$3

To include only certain chunks you can limit the chunks being used

webpack.config.js
`js
plugins: [
new HtmlWebpackPlugin({
chunks: ['app']
})
]
`

It is also possible to exclude certain chunks by setting the excludeChunks option

webpack.config.js
`js
plugins: [
new HtmlWebpackPlugin({
excludeChunks: [ 'dev-helper' ]
})
]
`

$3

If the minify option is set to true (the default when webpack's mode is 'production'),
the generated HTML will be minified using html-minifier
and the following options:

`js
{
collapseWhitespace: true,
removeComments: true,
removeRedundantAttributes: true,
removeScriptTypeAttributes: true,
removeStyleLinkTypeAttributes: true,
useShortDoctype: true
}
`

To use custom html-minifier options
pass an object to minify instead. This object will not be merged with the defaults above.

To disable minification during production mode set the minify option to false.

$3

If the meta option is set the html-webpack-plugin will inject meta tags.
For the default template the html-webpack-plugin will already provide a default for the viewport meta tag.

Please take a look at this well maintained list of almost all possible meta tags.

#### name/content meta tags

Most meta tags are configured by setting a name and a content attribute.
To add those use a key/value pair:

webpack.config.js
`js
plugins: [
new HtmlWebpackPlugin({
'meta': {
'viewport': 'width=device-width, initial-scale=1, shrink-to-fit=no',
// Will generate:
'theme-color': '#4285f4'
// Will generate:
}
})
]
`

#### Simulate http response headers

The http-equiv attribute is essentially used to simulate a HTTP response header.
This format is supported using an object notation which allows you to add any attribute:

webpack.config.js
`js
plugins: [
new HtmlWebpackPlugin({
'meta': {
'Content-Security-Policy': { 'http-equiv': 'Content-Security-Policy', 'content': 'default-src https:' },
// Will generate:
// Which equals to the following http header: Content-Security-Policy: default-src https:
'set-cookie': { 'http-equiv': 'set-cookie', content: 'name=value; expires=date; path=url' },
// Will generate:
// Which equals to the following http header: set-cookie: value; expires=date; path=url
}
})
]
`

$3

When the base option is used,
html-webpack-plugin will inject a base tag.
By default, a base tag will not be injected.

The following two are identical and will both insert :

`js
new HtmlWebpackPlugin({
'base': 'http://example.com/some/page.html'
})
`

`js
new HtmlWebpackPlugin({
'base': { 'href': 'http://example.com/some/page.html' }
})
`

The target can be specified with the corresponding key:

`js
new HtmlWebpackPlugin({
'base': {
'href': 'http://example.com/some/page.html',
'target': '_blank'
}
})
`

which will inject the element .

$3

For long term caching add contenthash/templatehash to the filename.

Example:

`js
plugins: [
new HtmlWebpackPlugin({
filename: 'index.[contenthash].html'
})
]
`

contenthash/templatehash is the hash of the content of the output file.

Optionally, You can configure like [:contenthash::]

* hashType - one of sha1, md5, sha256, sha512 or any other node.js supported hash type
* digestType - one of hex, base26, base32, base36, base49, base52, base58, base62, base64
* maxlength - maximum length of the generated hash in chars

Defaults: [md5:contenthash:hex:9999]

$3

To allow other plugins to alter the HTML this plugin executes
tapable hooks.

The lib/hooks.js contains all information
about which values are passed.

![Concept flow uml](https://github.com/jantimon/html-webpack-plugin/blob/master/flow.puml)

#### beforeAssetTagGeneration hook

`
AsyncSeriesWaterfallHook<{
assets: {
publicPath: string,
js: Array<{string}>,
css: Array<{string}>,
favicon?: string | undefined,
manifest?: string | undefined
},
outputName: string,
plugin: HtmlWebpackPlugin
}>
`

#### alterAssetTags hook

`
AsyncSeriesWaterfallHook<{
assetTags: {
scripts: Array,
styles: Array,
meta: Array,
},
outputName: string,
plugin: HtmlWebpackPlugin
}>
`

#### alterAssetTagGroups hook

`
AsyncSeriesWaterfallHook<{
headTags: Array,
bodyTags: Array,
outputName: string,
plugin: HtmlWebpackPlugin
}>
`

#### afterTemplateExecution hook

`
AsyncSeriesWaterfallHook<{
html: string,
headTags: Array,
bodyTags: Array,
outputName: string,
plugin: HtmlWebpackPlugin,
}>
`

#### beforeEmit hook

`
AsyncSeriesWaterfallHook<{
html: string,
outputName: string,
plugin: HtmlWebpackPlugin,
}>
`

#### afterEmit hook

`
AsyncSeriesWaterfallHook<{
outputName: string,
plugin: HtmlWebpackPlugin
}>
`

Example implementation: webpack-subresource-integrity

plugin.js
`js
// If your plugin is direct dependent to the html webpack plugin:
const HtmlWebpackPlugin = require('html-webpack-plugin');
// If your plugin is using html-webpack-plugin as an optional dependency
// you can use https://github.com/tallesl/node-safe-require instead:
const HtmlWebpackPlugin = require('safe-require')('html-webpack-plugin');

class MyPlugin {
apply (compiler) {
compiler.hooks.compilation.tap('MyPlugin', (compilation) => {
console.log('The compiler is starting a new compilation...')

// Static Plugin interface |compilation |HOOK NAME | register listener
HtmlWebpackPlugin.getHooks(compilation).beforeEmit.tapAsync(
'MyPlugin', // <-- Set a meaningful name here for stacktraces
(data, cb) => {
// Manipulate the content
data.html += 'The Magic Footer'
// Tell webpack to move on
cb(null, data)
}
)
})
}
}

module.exports = MyPlugin
`

webpack.config.js
`js
plugins: [
new MyPlugin({ options: '' })
]
`

Note that the callback must be passed the HtmlWebpackPluginData in order to pass this onto any other plugins listening on the same beforeEmit` event

Maintainers

src="https://avatars3.githubusercontent.com/u/4113649?v=3&s=150"> Jan Nicklas

src="https://avatars2.githubusercontent.com/u/4112409?v=3&s=150"> Thomas Sileghem

Backers

Thank you to all our backers!
If you want to support the project as well become a sponsor or a a backer.

Contributors

This project exists thanks to all the people who contribute.

You're free to contribute to this project by submitting issues and/or pull requests. This project is test-driven, so keep in mind that every change and new feature should be covered by tests.

This project uses the semistandard code style.

[npm]: https://img.shields.io/npm/v/html-webpack-plugin.svg
[npm-url]: https://npmjs.com/package/html-webpack-plugin

[node]: https://img.shields.io/node/v/html-webpack-plugin.svg
[node-url]: https://nodejs.org

[deps]: https://david-dm.org/jantimon/html-webpack-plugin.svg
[deps-url]: https://david-dm.org/jantimon/html-webpack-plugin

[tests]: http://img.shields.io/travis/jantimon/html-webpack-plugin.svg
[tests-url]: https://travis-ci.org/jantimon/html-webpack-plugin