handlebars-webpack-plugin-thereincarnator
v1.6.5
Published
Renders your html-template on build time
Downloads
6
Maintainers
thereincarnatorReadme
Server-side template rendering using Handlebars.
npm install handlebars-webpack-plugin --save-dev
Usage
In your webpack config register and setup the handlebars plugin
var path = require("path");
var HandlebarsPlugin = require("handlebars-webpack-plugin");
var webpackConfig = {
plugins: [
new HandlebarsPlugin({
// path to hbs entry file(s)
entry: path.join(process.cwd(), "app", "src", "*.hbs"),
// output path and filename(s). This should lie within the webpacks output-folder
// if ommited, the input filepath stripped of its extension will be used
output: path.join(process.cwd(), "build", "[name].html"),
// data passed to main hbs template: `main-template(data)`
data: require("./app/data/project.json"),
// or add it as filepath to rebuild data on change using webpack-dev-server
data: path.join(__dirname, "app/data/project.json"),
// globbed path to partials, where folder/filename is unique
partials: [
path.join(process.cwd(), "app", "src", "components", "*", "*.hbs")
],
// register custom helpers. May be either a function or a glob-pattern
helpers: {
nameOfHbsHelper: Function.prototype,
projectHelpers: path.join(process.cwd(), "app", "helpers", "*.helper.js")
},
// hooks
getTargetFilepath: function (filepath, outputTemplate) {},
onBeforeSetup: function (Handlebars) {},
onBeforeAddPartials: function (Handlebars, partialsMap) {},
onBeforeCompile: function (Handlebars, templateContent) {},
onBeforeRender: function (Handlebars, data) {},
onBeforeSave: function (Handlebars, resultHtml, filename) {},
onDone: function (Handlebars, filename) {}
})
]
};Partial ids are registered by parentFolder/filename (without file extensions)
Use handlebars in your main and partials like, i.e.
<body>
{{> partialFolder/partialName}}
{{> header/header title="page title"}}
{{> partial/content}}
</body>Html Webpack Plugin
Use the html-webpack-plugin to generate partials, that are dynamically registered to the handlebars-webpack-plugin
- the
HtmlWebpackPluginshould be placed before the HandlebarsWebpackPlugin - multiple HtmlWebpackPlugins may be used
- per default, the partials get registered to
html/<outputfilename>, i.e. a filename/dist/partials/head.hbswill be registered ashtml/headto handlebars
plugins: [
new HtmlWebpackPlugin({
title: "Generic Head Title",
// the template you want to use
template: path.join(__dirname, "src", "generatedpartial", "head.hbs"),
// the output file name
filename: path.join(__dirname, "dist", "partials", "head.hbs"),
inject: "head"
}),
new HandlebarsWebpackPlugin({
htmlWebpackPlugin: {
enabled: true, // register all partials from html-webpack-plugin, defaults to `false`
prefix: "html" // where to look for htmlWebpackPlugin output. default is "html"
},
entry: path.join(process.cwd(), "src", "hbs", "*.hbs"),
output: path.join(process.cwd(), "dist", "[name].html"),
partials: [
path.join(process.cwd(), "html",/* <-- this should match htmlWebpackPlugin.prefix */ "*", "*.hbs"),
path.join(process.cwd(), "src", "hbs", "*", "*.hbs")
]
})
]