Gathering detailed insights and metrics for metalsmith-handlebars-layouts
Gathering detailed insights and metrics for metalsmith-handlebars-layouts
Manage your Metalsmith layouts using Handlebars / Mustache syntax
Installations
npm install metalsmith-handlebars-layoutsDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
22.4.0
NPM Version
10.8.1
Releases
Unable to fetch releases
Languages
1
JavaScript
JavaScript (100%)
Developer
fidian
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
NOASSERTION License
1 Stars
17 Commits
1 Watchers
1 Branches
1 Contributors
Updated on Nov 22, 2024
Maintainers
1
Package Meta Information
Latest Version
1.4.0
Package Id
metalsmith-handlebars-layouts@1.4.0
Unpacked Size
11.65 kB
Size
4.58 kB
File Count
7
NPM Version
10.8.1
Node Version
22.4.0
Published on
Nov 22, 2024
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
metalsmith-handlebars-layouts
Wraps page contents in a layout. Safe to use with live reload systems, like metalsmith-serve. Similar to metalsmith-nested but also is safe for live reloads and you point at the parent/ancestor instead of the child/descendant.
What It Does
Most sites repeat the header and footer on each of their pages. This plugin takes the header and footer out of the page and puts them into separate files. The plugin is straightforward to use and doesn't dictate any decisions outside of using handlebars for the layouts.
Example content file, 'src/page.html':
---
layout: page.md
title: Just Testing
color: blue
---
Hi, this is my page.
* Red
* Green
* {{color}}
Here's a layout file, 'layouts/page.md':
<html><head><title>{{title}}</title></head>
<body>
{{{contents}}}
</body></html>
The resulting file object (dest/page.html) would look like this:
<html><head><title>Just Testing</title></head>
<body>
<p>Hi, this is my page.</p>
<ul>
<li>Red</li>
<li>Green</li>
<li>{{color}}</li>
</ul>
</body></html>
Under the hood, the contents of the file are inserted into the layout, then the file object is updated with the new contents and other plugins can continue with processing. If you notice carefully, the {{color}} replacement was not performed. That's because the contents must be completely ready before insertion into the layouts. If you like, you can look at metalsmith-handlebars-contents to do that replacement for you.
Partials can also be used for organization of layouts. This will run the layout for each file, so the file's metadata can also change how the layout looks.
Installation
npm can do this for you.
npm install --save metalsmith-handlebars-layouts
Usage
Include this like you would include any other plugin. Here's a CLI example that also shows the default options. You don't need to specify any of these unless you want to change its value.
{
"plugins": {
"metalsmith-handlebars-layouts": {
"data": [],
"decorators": [],
"helpers": [],
"layouts": "./layouts/",
"match": "**/*.html",
"matchOptions": {},
"partials": ["./layouts/partials/**/*"]
}
}
}
And this is how you use it in JavaScript, with a small description of each option.
// Load this, just like other plugins.
var handlebarsLayouts = require("metalsmith-handlebars-layouts");
// Then in your list of plugins you use it.
.use(handlebarsLayouts())
// Alternately, you can specify options. The values shown here are
// the defaults.
.use(handlebarsLayouts({
// Data files to load or data objects to add to global data.
data: [],
// Decorators to add
decorators: [],
// Helper functions to include
helpers: [],
// Directory that holds layouts, outside of the src/ folder.
// Does not recurse and only finds top-level files.
layouts: './layouts/',
// Pattern of files to match in case you want to limit processing
// to specific files.
match: "**/*.html",
// Options for matching files. See metalsmith-plugin-kit for
// more information.
matchOptions: {},
// Directories that hold partials for processing the content
partials: ['./layouts/partials/**/*']
})
The items in the data, decorators, helpers, and partials arrays can be strings or objects. They are passed to handlebars-wax using the appropriate method.
This uses metalsmith-plugin-kit to match files. The .matchOptions object can be filled with options to control how files are matched.
Development
This plugin is licensed under the [MIT License][License] with an additional non-advertising clause. See the [full license text][License] for information.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Warn: project license file does not contain an FSF or OSI license.
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 0/11 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 6 are checked with a SAST tool
Score
3
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More