parcel-plugin-handlebars-benz
v0.4.8
Published
Parcel plugin to compile handlebars layouts templates.
Downloads
1
Maintainers
benzleungReadme
parcel-plugin-handlebars-benz
Update:
- Fixed parcel watch and cache issue.
module.exports = {
partials: ['src/markup/partials', 'src/markup2/partials'],
/* and also data, decorators, helpers, layouts */
};parcel-plugin-handlebars
【What is Parcel】【What is Handlebars】
Install
Using plugins in Parcel could not be any simpler. All you need to do is install them and save in your package.json. Plugins should be named with the prefix parcel-plugin-, e.g. parcel-plugin-foo. Any dependencies listed in package.json with this prefix will be automatically loaded during initialization.
Install with npm:
$ npm install --save parcel-plugin-handlebarsInstall with yarn:
$ yarn add parcel-plugin-handlebarsThe plugin will process any templated handlebars file extensions (.hbs, .handlebars and .html)
Examples
Configuration
The plugin has the following config defaults. These are required for handlebars to map all dependencies for compiling handlebars templates.
module.exports = {
data: 'src/markup/data',
decorators: 'src/markup/decorators',
helpers: 'src/markup/helpers',
layouts: 'src/markup/layouts',
partials: 'src/markup/partials',
};Custom Configuration
If you would like to enforce your own folder structure simply create handlebars.config.js or hbs.config.js in your project root.
module.exports = {
data: 'views/json',
helpers: 'views/tools',
layouts: 'views/templates',
partials: 'views/partials',
};Features
frontmatter
The plugin has built in support for frontmatter yaml. Processed yaml data will be passed into the templates before compilation. frontmatter yaml data will preferably be at the top of the template file such as the following example:
Source - example.hbs
---
title: This is a heading
desc: this is a paragraph
names:
- bob
- jane
- mark
---
{{!< mainlayout}}
<h1>{{title}}</h1>
<p>{{desc}}</p>
<ul>
{{#each names}}
<li>{{this}}</li>
{{/each}}
</ul>Output - example.html
<html>
<body>
<h1>This is a heading</h1>
<p>this is a paragraph</p>
<ul>
<li>bob</li>
<li>jane</li>
<li>mark</li>
</ul>
</body>
</html>Handlebars Layouts
The plugin has built in support for handlebars-layouts. The advanced example shows how to take advantage of handlebars layouts. Please refer to their documentation for more information.
Handlebars Helpers
The plugin is also including all helpers found in the npm package handlebars-helpers. Please refer to their documentation for example usages.
Environment Variables
During compililation the plugin will also pass the following variable(s) to the template:
- NODE_ENV
This can be useful when you want specific code to show up on production builds.
{{#eq NODE_ENV "production"}}
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-XXXX');</script>
<!-- End Google Tag Manager -->
{{/eq}}Or perhaps the opposite
{{#isnt NODE_ENV "production"}}
<span class="dev-banner sticky full">
You're in DEVELOPMENT mode
</span>
{{/isnt}}