/html-webpack-banner-plugin

Adds a banner to the top of generated html.

Primary LanguageJavaScriptMIT LicenseMIT

html-webpack-banner-plugin

Build Status

This is an extension plugin for the webpack plugin html-webpack-plugin - a plugin that simplifies the creation of HTML files to serve your webpack bundles.

Adds a banner to the top of generated html.

Installation

Install the plugin with npm:

$ npm install -d html-webpack-banner-plugin

Install the plugin with yarn:

$ yarn add -D html-webpack-banner-plugin

Basic Usage

Load the plugin

const HtmlWebpackBannerPlugin = require('html-webpack-banner-plugin');

and add it to your webpack config as follows:

plugins: [
    new HtmlWebpackPlugin(),
    new HtmlWebpackBannerPlugin({
        banner: '<!-- my banner -->',
    }),
]

Options

{
    banner: string, // the banner as string, it will be wrapped in a comment
    raw: boolean, // if true, banner will not be wrapped in a comment
}

License

MIT