metalsmith-layouts
Advanced tools
A metalsmith plugin for layouts
This plugin passes your source files to a template as contents and renders it with the templating engine of your choice. You can use any templating engine supported by consolidate.js. Pass options to it with the Javascript API or CLI. The options are:
engine: templating engine (required)default: default template (optional)directory: directory for the layouts, layouts by default (optional)pattern: only files that match this pattern will be processed (optional)$ npm install metalsmith-layouts
Configuration in metalsmith.json:
{
"plugins": {
"metalsmith-layouts": {
"engine": "handlebars"
}
}
}
Source file src/index.html:
---
layout: layout.html
title: The title
---
<p>The contents</p>
Layout layouts/layout.html:
<!doctype html>
<html>
<head>
<title>{{title}}</title>
</head>
<body>
{{{contents}}}
</body>
</html>
Results in dist/index.html:
<!doctype html>
<html>
<head>
<title>The title</title>
</head>
<body>
<p>The contents</p>
</body>
</html>
This plugin originated in metalsmith-templates issue #35. Splitting up metalsmith-templates into two plugins was suggested by Ian Storm Taylor. The results are:
metalsmith-templates with inPlace: truemetalsmith-templates with inPlace: falseBoth plugins have been optimised for each use case. For metalsmith-layouts the differences with metalsmith-templates are:
inPlace option has been removedlayout instead of template in the front-matter to specify a layoutlayouts instead of templatesFor further documentation see the original metalsmith-templates, but keep these differences in mind.
MIT
1.0.0 - November 18, 2014
inPlace optionlayout instead of template in the front-matter to specify a layoutlayouts instead of templatesFAQs
A metalsmith plugin for layouts.
The npm package metalsmith-layouts receives a total of 2,176 weekly downloads. As such, metalsmith-layouts popularity was classified as popular.
We found that metalsmith-layouts demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."