English

HTML

During the build process, Rsbuild compiles HTML templates and template parameters to generate HTML files.

Rsbuild provides several configuration options for HTML templates. This section explains the basic usage of these options.

HTML generation

Rsbuild generates an HTML file for each entry defined in source.entry.

rsbuild.config.ts

export default {
  source: {
    entry: {
      foo: './src/pages/foo/index.ts', // generate foo.html
      bar: './src/pages/bar/index.ts', // generate bar.html
    },
  },
};

See source.entry - HTML generation for more details on how to control HTML generation.

Set template

Use html.template to define the path to a custom HTML template.

rsbuild.config.ts

export default {
  html: {
    template: './static/index.html',
  },
};

When html.template is not set, Rsbuild uses this built-in HTML template:

defaultTemplate.html

<!doctype html>
<html>
  <head></head>
  <body>
    <div id="<%= mountId %>"></div>
  </body>
</html>

In the default template, id="<%= mountId %>" is replaced with id="root". Modify this value using the html.mountId option.

Set page title

You can set the HTML <title> tag using the html.title config.

When your project has only one page, set html.title directly:

rsbuild.config.ts

export default {
  html: {
    title: 'example',
  },
};

When your project has multiple pages, you can set different titles for each page based on the entry name.

rsbuild.config.ts

export default {
  html: {
    title({ entryName }) {
      const titles = {
        foo: 'Foo',
        bar: 'Bar',
      };
      return titles[entryName];
    },
  },
};

TIP

For single-page applications (SPA), Rsbuild includes an initial title in the HTML page, but you typically need to dynamically update the page title when routes change, for example using routing libraries or libraries like React Helmet.

Set page icon

Rsbuild supports setting both the favicon and the web application icon.

By default, Rsbuild automatically looks for favicon files in the public directory. If you want to customize the favicon, use the html.favicon option:

rsbuild.config.ts

export default {
  html: {
    favicon: './src/assets/icon.png',
  },
};

You can also use the html.appIcon option to define web application icons, which are displayed when users add your site to their mobile device's home screen:

rsbuild.config.ts

export default {
  html: {
    appIcon: {
      name: 'My Website',
      icons: [
        { src: './src/assets/logo-192.png', size: 192 },
        { src: './src/assets/logo-512.png', size: 512 },
      ],
    },
  },
};

Set meta tags

You can set meta tags using the html.meta config.

Rsbuild defaults to setting the charset and viewport meta tags:

<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />

You can also add custom meta tags, like a description:

rsbuild.config.ts

export default {
  html: {
    meta: {
      description: 'a description of the page',
    },
  },
};

The generated meta tag in HTML is:

<meta name="description" content="a description of the page" />

Default template engine

Rsbuild has a built-in default template engine for processing HTML template files. Its syntax resembles a subset of EJS, with some differences. When an HTML template file has a .html extension, Rsbuild uses the built-in template engine to parse it.

For example, if a text parameter is defined in the template with the value 'world', Rsbuild automatically replaces <%= text %> with the specified value during the build.

<!-- Input  -->
<div>hello <%= text %>!</div>

<!-- Output -->
<div>hello world!</div>

Template parameters

In HTML templates, you can use a variety of template parameters. Rsbuild injects the following default template parameters:

type DefaultParameters = {
  mountId: string; // the value of `html.mountId` config
  entryName: string; // entry name
  assetPrefix: string; // the value of dev.assetPrefix or output.assetPrefix configs
  compilation: Compilation; // Compilation object of Rspack
  rspackConfig: Rspack.Configuration; // Rspack config object
  // generated by html-rspack-plugin
  htmlPlugin: {
    tags: {
      headTags: HtmlTagObject[];
      bodyTags: HtmlTagObject[];
    };
    files: {
      publicPath: string;
      js: string[];
      css: string[];
      favicon?: string;
    };
  };
};

You can use the html.templateParameters config to pass custom template parameters. For example:

rsbuild.config.ts

export default {
  html: {
    templateParameters: {
      text: 'world',
    },
  },
};

Then you can read parameters in the HTML template with <%= text %>:

index.html

<div>hello <%= text %>!</div>

The compiled HTML code will be:

dist/index.html

<div>hello world!</div>

Parameter escaping

When using <%= text %>, the parameters will not be escaped. You can use <%- text %> to escape parameters.

For example, if the value of the parameter text is '<script>', it will be escaped to <script>:

<!-- Input  -->
<div>hello <%- text %>!</div>

<!-- Output -->
<div>hello &lt;script&gt;!</div>

TIP

Note that Rsbuild's default escape syntax is different from EJS. In EJS, the default escape syntax is <%= text %>, whereas Rsbuild's default escape syntax is <%- text %>.

Conditional statements

if condition:

rsbuild.config.ts

export default {
  html: {
    templateParameters: {
      show: true,
    },
  },
};

<% if (show) { %>
<p>show is true</p>
<% } %>

if/else condition:

<% if (show) { %>
<p>show is true</p>
<% } else { %>
<p>show is false</p>
<% } %>

else if condition:

rsbuild.config.ts

export default {
  html: {
    templateParameters: {
      count: 7,
    },
  },
};

<% if (count > 10) { %>
<p>count > 10</p>
<% } else if (count > 5) { %>
<p>count > 5</p>
<% } else { %>
<p>count ≤ 5</p>
<% } %>

Nested conditions:

rsbuild.config.ts

export default {
  html: {
    templateParameters: {
      parent: true,
      child: true,
    },
  },
};

<% if (parent) { %>
<p>parent is true</p>
  <% if (child) { %>
  <p>child is true</p>
  <% } %>
<% } %>

Ternary operator:

rsbuild.config.ts

export default {
  html: {
    templateParameters: {
      show: true,
      value: 'success',
    },
  },
};

<p>result: <%= show ? value : 'none' %></p>

Loop statements

for loop:

rsbuild.config.ts

export default {
  html: {
    templateParameters: {
      items: ['Item 1', 'Item 2', 'Item 3'],
    },
  },
};

index.html

<ul>
  <% for (let i = 0; i < items.length; i++) { %>
  <li><%= items[i] %></li>
  <% } %>
</ul>

forEach loop:

index.html

<ul>
  <% items.forEach(function(item, index) { %>
  <li><%= item %> <%= index %></li>
  <% }); %>
</ul>

for...of loop:

index.html

<ul>
  <% for (let item of items) { %>
  <li><%= item %></li>
  <% } %>
</ul>

Other template engines

Rsbuild also supports using other template engines via plugins, such as EJS and Pug.

EJS

Rsbuild's built-in template syntax has some differences from EJS. To use the full EJS syntax, you can use a plugin. See rsbuild-plugin-ejs for more details.

Pug

Rsbuild supports the Pug template engine via a plugin. See @rsbuild/plugin-pug for more details.

Injecting tags

You can insert any tags into the HTML files generated by Rsbuild by configuring html.tags.

In the HTML template, the htmlPlugin.tags variable provides access to all tags inserted into the HTML:

index.html

<html>
  <head>
    <%= htmlPlugin.tags.headTags %>
  </head>
  <body>
    <div id="root"></div>
    <%= htmlPlugin.tags.bodyTags %>
  </body>
</html>

The html.tags config allows you to modify HTML tags by updating these tag variables. Here is a basic example:

rsbuild.config.ts

export default {
  html: {
    tags: [
      { tag: 'script', attrs: { src: 'https://cdn.example.com/my-script.js' } },
    ],
  },
};

The generated HTML file looks like this:

<html>
  <head>
    <script src="https://cdn.example.com/my-script.js"></script>
    <!-- some other headTags... -->
  </head>
  <body>
    <!-- some other bodyTags... -->
  </body>
</html>

For more usage, please refer to: html.tags.

TIP

Typically, you do not need to manually use the htmlPlugin.tags.headTags and htmlPlugin.tags.bodyTags template parameters because Rsbuild automatically injects these tags. See html.inject for more details on adjusting the injection location.

HTML plugin

Rsbuild internally implements HTML-related features based on html-rspack-plugin. It is a fork of html-webpack-plugin, with the same features and options.

You can modify the html-rspack-plugin options via tools.htmlPlugin, or disable the default html-rspack-plugin.

For example:

rsbuild.config.ts

export default {
  tools: {
    htmlPlugin(config, { entryName }) {
      if (process.env.NODE_ENV === 'production') {
        config.filename = `${entryName}.[contenthash:8].html`;
      }
    },
  },
};

HTML minification

Rsbuild currently does not minify HTML files. If you need to minify HTML files, you can use the rsbuild-plugin-html-minifier-terser plugin.

HTML

During the build process, Rsbuild compiles HTML templates and template parameters to generate HTML files.

Rsbuild provides several configuration options for HTML templates. This section explains the basic usage of these options.

HTML generation

Rsbuild generates an HTML file for each entry defined in source.entry.

rsbuild.config.ts

export default {
  source: {
    entry: {
      foo: './src/pages/foo/index.ts', // generate foo.html
      bar: './src/pages/bar/index.ts', // generate bar.html
    },
  },
};

See source.entry - HTML generation for more details on how to control HTML generation.

Set template

Use html.template to define the path to a custom HTML template.

rsbuild.config.ts

export default {
  html: {
    template: './static/index.html',
  },
};

When html.template is not set, Rsbuild uses this built-in HTML template:

defaultTemplate.html

<!doctype html>
<html>
  <head></head>
  <body>
    <div id="<%= mountId %>"></div>
  </body>
</html>

In the default template, id="<%= mountId %>" is replaced with id="root". Modify this value using the html.mountId option.

Set page title

You can set the HTML <title> tag using the html.title config.

When your project has only one page, set html.title directly:

rsbuild.config.ts

export default {
  html: {
    title: 'example',
  },
};

When your project has multiple pages, you can set different titles for each page based on the entry name.

rsbuild.config.ts

export default {
  html: {
    title({ entryName }) {
      const titles = {
        foo: 'Foo',
        bar: 'Bar',
      };
      return titles[entryName];
    },
  },
};

TIP

Set page icon

Rsbuild supports setting both the favicon and the web application icon.

By default, Rsbuild automatically looks for favicon files in the public directory. If you want to customize the favicon, use the html.favicon option:

rsbuild.config.ts

export default {
  html: {
    favicon: './src/assets/icon.png',
  },
};

You can also use the html.appIcon option to define web application icons, which are displayed when users add your site to their mobile device's home screen:

rsbuild.config.ts

export default {
  html: {
    appIcon: {
      name: 'My Website',
      icons: [
        { src: './src/assets/logo-192.png', size: 192 },
        { src: './src/assets/logo-512.png', size: 512 },
      ],
    },
  },
};

Set meta tags

You can set meta tags using the html.meta config.

Rsbuild defaults to setting the charset and viewport meta tags:

<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />

You can also add custom meta tags, like a description:

rsbuild.config.ts

export default {
  html: {
    meta: {
      description: 'a description of the page',
    },
  },
};

The generated meta tag in HTML is:

<meta name="description" content="a description of the page" />

Default template engine

For example, if a text parameter is defined in the template with the value 'world', Rsbuild automatically replaces <%= text %> with the specified value during the build.

<!-- Input  -->
<div>hello <%= text %>!</div>

<!-- Output -->
<div>hello world!</div>

Template parameters

In HTML templates, you can use a variety of template parameters. Rsbuild injects the following default template parameters:

type DefaultParameters = {
  mountId: string; // the value of `html.mountId` config
  entryName: string; // entry name
  assetPrefix: string; // the value of dev.assetPrefix or output.assetPrefix configs
  compilation: Compilation; // Compilation object of Rspack
  rspackConfig: Rspack.Configuration; // Rspack config object
  // generated by html-rspack-plugin
  htmlPlugin: {
    tags: {
      headTags: HtmlTagObject[];
      bodyTags: HtmlTagObject[];
    };
    files: {
      publicPath: string;
      js: string[];
      css: string[];
      favicon?: string;
    };
  };
};

You can use the html.templateParameters config to pass custom template parameters. For example:

rsbuild.config.ts

export default {
  html: {
    templateParameters: {
      text: 'world',
    },
  },
};

Then you can read parameters in the HTML template with <%= text %>:

index.html

<div>hello <%= text %>!</div>

The compiled HTML code will be:

dist/index.html

<div>hello world!</div>

Parameter escaping

When using <%= text %>, the parameters will not be escaped. You can use <%- text %> to escape parameters.

For example, if the value of the parameter text is '<script>', it will be escaped to <script>:

<!-- Input  -->
<div>hello <%- text %>!</div>

<!-- Output -->
<div>hello &lt;script&gt;!</div>

TIP

Note that Rsbuild's default escape syntax is different from EJS. In EJS, the default escape syntax is <%= text %>, whereas Rsbuild's default escape syntax is <%- text %>.

Conditional statements

if condition:

rsbuild.config.ts

export default {
  html: {
    templateParameters: {
      show: true,
    },
  },
};

<% if (show) { %>
<p>show is true</p>
<% } %>

if/else condition:

<% if (show) { %>
<p>show is true</p>
<% } else { %>
<p>show is false</p>
<% } %>

else if condition:

rsbuild.config.ts

export default {
  html: {
    templateParameters: {
      count: 7,
    },
  },
};

<% if (count > 10) { %>
<p>count > 10</p>
<% } else if (count > 5) { %>
<p>count > 5</p>
<% } else { %>
<p>count ≤ 5</p>
<% } %>

Nested conditions:

rsbuild.config.ts

export default {
  html: {
    templateParameters: {
      parent: true,
      child: true,
    },
  },
};

<% if (parent) { %>
<p>parent is true</p>
  <% if (child) { %>
  <p>child is true</p>
  <% } %>
<% } %>

Ternary operator:

rsbuild.config.ts

export default {
  html: {
    templateParameters: {
      show: true,
      value: 'success',
    },
  },
};

<p>result: <%= show ? value : 'none' %></p>

Loop statements

for loop:

rsbuild.config.ts

export default {
  html: {
    templateParameters: {
      items: ['Item 1', 'Item 2', 'Item 3'],
    },
  },
};

index.html

<ul>
  <% for (let i = 0; i < items.length; i++) { %>
  <li><%= items[i] %></li>
  <% } %>
</ul>

forEach loop:

index.html

<ul>
  <% items.forEach(function(item, index) { %>
  <li><%= item %> <%= index %></li>
  <% }); %>
</ul>

for...of loop:

index.html

<ul>
  <% for (let item of items) { %>
  <li><%= item %></li>
  <% } %>
</ul>

Other template engines

Rsbuild also supports using other template engines via plugins, such as EJS and Pug.

EJS

Rsbuild's built-in template syntax has some differences from EJS. To use the full EJS syntax, you can use a plugin. See rsbuild-plugin-ejs for more details.

Pug

Rsbuild supports the Pug template engine via a plugin. See @rsbuild/plugin-pug for more details.

Injecting tags

You can insert any tags into the HTML files generated by Rsbuild by configuring html.tags.

In the HTML template, the htmlPlugin.tags variable provides access to all tags inserted into the HTML:

index.html

<html>
  <head>
    <%= htmlPlugin.tags.headTags %>
  </head>
  <body>
    <div id="root"></div>
    <%= htmlPlugin.tags.bodyTags %>
  </body>
</html>

The html.tags config allows you to modify HTML tags by updating these tag variables. Here is a basic example:

rsbuild.config.ts

export default {
  html: {
    tags: [
      { tag: 'script', attrs: { src: 'https://cdn.example.com/my-script.js' } },
    ],
  },
};

The generated HTML file looks like this:

<html>
  <head>
    <script src="https://cdn.example.com/my-script.js"></script>
    <!-- some other headTags... -->
  </head>
  <body>
    <!-- some other bodyTags... -->
  </body>
</html>

For more usage, please refer to: html.tags.

TIP

HTML plugin

Rsbuild internally implements HTML-related features based on html-rspack-plugin. It is a fork of html-webpack-plugin, with the same features and options.

You can modify the html-rspack-plugin options via tools.htmlPlugin, or disable the default html-rspack-plugin.

For example:

rsbuild.config.ts

export default {
  tools: {
    htmlPlugin(config, { entryName }) {
      if (process.env.NODE_ENV === 'production') {
        config.filename = `${entryName}.[contenthash:8].html`;
      }
    },
  },
};

HTML minification

Rsbuild currently does not minify HTML files. If you need to minify HTML files, you can use the rsbuild-plugin-html-minifier-terser plugin.

#HTML

#HTML generation

#Set template

#Set page title

#Set page icon

#Set meta tags

#Default template engine

#Template parameters

#Parameter escaping

#Conditional statements

#Loop statements

#Other template engines

#EJS

#Pug

#Injecting tags

#HTML plugin

#HTML minification

#HTML

#HTML generation

#Set template

#Set page title

#Set page icon

#Set meta tags

#Default template engine

#Template parameters

#Parameter escaping

#Conditional statements

#Loop statements

#Other template engines

#EJS

#Pug

#Injecting tags

#HTML plugin

#HTML minification

HTML

HTML generation

Set template

Set page title

Set page icon

Set meta tags

Default template engine

Template parameters

Parameter escaping

Conditional statements

Loop statements

Other template engines

EJS

Pug

Injecting tags

HTML plugin

HTML minification

HTML

HTML generation

Set template

Set page title

Set page icon

Set meta tags

Default template engine

Template parameters

Parameter escaping

Conditional statements

Loop statements

Other template engines

EJS

Pug

Injecting tags

HTML plugin

HTML minification