How to inject custom meta tags in html-webpack-plugin?

javascript node.js webpack html-webpack-plugin
Nicky picture Nicky · Mar 25, 2017 · Viewed 11.4k times · Source

I use Webpack along with the plugin html-webpack-plugin. Based on an environment variable, I want to inject a <meta></meta> tag into the final index.html file.

How do I do this?

Answer

Michael Jungo picture Michael Jungo · Mar 25, 2017

You can define your own template. It's briefly mentioned in Writing Your Own Templates that you can pass any options you'd like to it and use them in the template with htmlWebpackPlugin.options:

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.

For example you could define the author with the environment variable AUTHOR and add an author option to the plugin:

new HtmlWebpackPlugin({
  template: 'template.ejs',
  author: process.env.AUTHOR
})

In your template.ejs you can create a <meta> tag with that information:

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
    <% if (htmlWebpackPlugin.options.author) { %>
    <meta name="author" content="<%= htmlWebpackPlugin.options.author %>">
    <% } %>
  </head>
  <body>
  </body>
</html>

You could use a .html file instead and the plugin will fallback to ejs-loader, but if you have html-loader configured for .html files, it will use that instead of the fallback, so the embedding won't work.

When AUTHOR is set it will include the meta tag with the author, otherwise it's not included. Running:

AUTHOR='Foo Bar' webpack

will include the following meta tag:

<meta name="author" content="Foo Bar">

Related questions

How to load images through webpack when using HTMLWebpackPlugin?

I am using HTMLWebpackPlugin and in my template I have an img tag: <img src="./images/logo/png"> If you notice, here I am using a relative path thinking webpack will trigger the file loader that's configured in …

Read More
How to build minified and uncompressed bundle with webpack?

Here's my webpack.config.js var webpack = require("webpack"); module.exports = { entry: "./entry.js", devtool: "source-map", output: { path: "./dist", filename: "bundle.min.js" }, plugins: [ new webpack.optimize.UglifyJsPlugin({minimize: true}) ] }; I'm building with $ webpack In my dist folder, I'm only …

Read More
How to determine the installed webpack version

Especially during the transition from webpack v1 to v2, it would be important to programmatically determine what webpack version is installed, but I cannot seem to find the appropriate API.

Read More