Skip to main content

Basic Setup

Install additional packages for CSS/SCSS:

npm install --save-dev css-loader sass sass-loader

There is an example of the project structure for a multiple pages:

my-project/
├── dist/  (generated output)
├── src/
│   ├── images/
│   │   ├── favicon.
│   │   ├── banner.jpg
│   ├── styles/
│   │   ├── vendor.scss
│   ├── scripts/
│   │   ├── vendor.js
│   ├── pages/
│   │   ├── home/
│   │   │   ├── index.html
│   │   │   ├── style.scss
│   │   │   ├── script.js
│   │   ├── about/
│   │   │   ├── index.html
│   │   │   ├── style.scss
│   │   │   ├── script.js
├── webpack.config.js
└── package.json

The recommended base Webpack configuration, webpack.config.js:

const path = require('path');
const HtmlBundlerPlugin = require('html-bundler-webpack-plugin');

module.exports = {
  resolve: {
    alias: {
      '@images': path.join(__dirname, 'src/images'),
      '@scripts': path.join(__dirname, 'src/scripts'),
      '@styles': path.join(__dirname, 'src/styles'),
    },
  },
  plugins: [
    new HtmlBundlerPlugin({
      entry: {
        // Define entry points for pages
        index: './src/pages/home/index.html', // --> dist/index.html
        'about-us': './src/pages/about/index.html', // --> dist/about-us.html
      },
      js: {
        filename: 'js/[name].[contenthash:8].js', // Output JS filename
      },
      css: {
        filename: 'css/[name].[contenthash:8].css', // Output CSS filename
      },
    }),
  ],
  module: {
    rules: [
      {
        test: /\.s?css$/,
        use: ['css-loader', 'sass-loader'],
      },
      {
        test: /\.(png|jpe?g|svg)$/,
        type: 'asset/resource',
        generator: {
          filename: 'img/[name].[hash:8][ext]', // Output images filename
        },
      },
    ],
  },
};
info
  • The default output directory is dist/.
  • All output filenames are relative to the output directory.
  • The entry key determines the output HTML filename (excluding .html).
  • The js.filename is the output JS filename.
  • The css.filename is the output CSS filename.
  • The generator.filename is the output filename for matched images.
tip

In sources use Webpack aliases defined in resolve.alias to avoid relative paths like:

  • ../../images/
  • ../../styles/
  • ../../scripts/
  • etc.

The template contains Webpack aliases to source resources:

<!DOCTYPE html>
<html lang="en">
<head>
  <title>Home</title>
  <link href="@images/favicon.svg" rel="icon" type="image/svg+xml">
  <link href="./style.scss" rel="stylesheet"> <!-- local template directory -->
  <link href="@styles/vendor.scss" rel="stylesheet">
  <script src="@scripts/vendor.js" defer="defer"></script>
</head>
<body>
  <h1>Home</h1>
  <img src="@images/banner.png" alt="banner" />
  <script src="./script.js"></script> <!-- local template directory -->
</body>
</html>

The generated output:

my-project/
├── dist/
│   ├── img/
│   │   ├── favicon.f2794493.svg
│   │   ├── banner.7b396424.png
│   ├── js/
│   │   ├── script.0132c52e.js
│   │   ├── vendor.63bd5560.js
│   ├── css/
│   │   ├── style.1b2f962c.css
│   │   ├── vendor.487ba887.css
|   ├── index.html
|   ├── about-us.html
├── src/