Neutrino HTML Template Middleware
@neutrinojs/html-template
is Neutrino middleware for automatically creating
HTML files for configured entry points.
Requirements
- Node.js 10+
- Yarn v1.2.1+, or npm v5.4+
- Neutrino 9
- webpack 4
Installation
@neutrinojs/html-template
can be installed via the Yarn or npm clients.
Yarn
❯ yarn add --dev @neutrinojs/html-template
npm
❯ npm install --save-dev @neutrinojs/html-template
Usage
@neutrinojs/html-template
can be consumed from the Neutrino API, middleware,
or presets. Require this package and plug it into Neutrino:
const htmlTemplate = require('@neutrinojs/html-template');
neutrino.use(
htmlTemplate({
template: require.resolve('@neutrinojs/html-template/template.ejs'),
appMountId: 'root',
lang: 'en',
meta: {
viewport: 'width=device-width, initial-scale=1',
},
pluginId: 'html',
}),
);
neutrino.use(
htmlTemplate({
title: 'React Application',
}),
);
const htmlTemplate = require('@neutrinojs/html-template');
module.exports = {
use: [
htmlTemplate({
template: require.resolve('@neutrinojs/html-template/template.ejs'),
appMountId: 'root',
lang: 'en',
meta: {
viewport: 'width=device-width, initial-scale=1',
},
pluginId: 'html',
}),
],
};
module.exports = {
use: [
htmlTemplate({
title: 'React Application',
}),
],
};
Customization
@neutrinojs/html-template
creates some conventions to make overriding the
configuration easier once you are ready to make changes.
Plugins
The following is a list of plugins and their identifiers which can be
overridden:
Name | Description | NODE_ENV |
---|
html | Automatically generates HTML files for configured entry points. | all |
Contributing
This middleware is part of the
neutrino repository, a monorepo
containing all resources for developing Neutrino and its core presets and
middleware. Follow the
contributing guide for details.