metalsmith-layouts
Advanced tools
A metalsmith plugin for layouts
This plugin allows you to apply layouts to your source files. It passes your source files to the selected layout as the variable contents and renders the result with the templating engine of your choice. You can use any templating engine supported by consolidate.js. For support questions please use stack overflow or our slack channel. For templating engine specific questions try the aforementioned channels, as well as the documentation for consolidate.js and your templating engine of choice.
$ 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 build/index.html:
<!doctype html>
<html>
<head>
<title>The title</title>
</head>
<body>
<p>The contents</p>
</body>
</html>
This is a very basic example. For more elaborate examples see the metalsmith tag on stack overflow.
You can pass options to metalsmith-layouts with the Javascript API or CLI. The options are:
.html (optional)The engine that will render your layouts. Metalsmith-layouts uses consolidate.js to render templating syntax, so any engine supported by consolidate.js can be used. Don't forget to install the templating engine separately. So this metalsmith.json:
{
"plugins": {
"metalsmith-layouts": {
"engine": "swig"
}
}
}
Will render your layouts with swig.
The default layout to use. Can be overridden with the layout key in each file's YAML frontmatter, by passing either a layout or false. Passing false will skip the file entirely.
If a default layout has been specified, metalsmith-layouts will process all files unless a pattern has been passed. Don't forget to specify the default template's file extension. So this metalsmith.json:
{
"plugins": {
"metalsmith-layouts": {
"engine": "swig",
"default": "default.html"
}
}
}
Will apply the default.html layout to all files, unless overridden in the frontmatter.
The directory where metalsmith-layouts looks for the layouts. By default this is layouts. So this metalsmith.json:
{
"plugins": {
"metalsmith-layouts": {
"engine": "swig",
"directory": "templates"
}
}
}
Will look for layouts in the templates directory, instead of in layouts.
The directory where metalsmith-layouts looks for partials. Each partial is named by removing the file extension from its path (relative to the partials directory), so make sure to avoid duplicates. So this metalsmith.json:
{
"plugins": {
"metalsmith-layouts": {
"engine": "handlebars",
"partials": "partials"
}
}
}
Would mean that a partial at partials/nav.html can be used in layouts as {{> nav }}, and partials/nested/footer.html can be used as {{> nested/footer }}. Note that passing anything but a string to the partials option will pass the option on to consolidate.
Make sure to check consolidate.js and your templating engine's documentation for guidelines on how to use partials.
Only files that match this pattern will be processed. So this metalsmith.json:
{
"plugins": {
"metalsmith-layouts": {
"engine": "swig",
"pattern": "*.md"
}
}
}
Would only process files that have the .md extension.
Change the file extension of processed files to .html (optional). This option is set to false by default. So for example this metalsmith.json:
{
"plugins": {
"metalsmith-in-place": {
"engine": "handlebars",
"rename": true
}
}
}
Would rename the extensions of all processed files to .html.
Any unrecognised options will be passed on to consolidate.js. You can use this, for example, to disable caching by passing cache: false. See the consolidate.js documentation for all options supported by consolidate.
This plugin is a fork of the now deprecated metalsmith-templates. Splitting up metalsmith-templates into two plugins was suggested by Ian Storm Taylor. The results are:
MIT
1.6.4 - February 22, 2016
FAQs
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."