hiro/metalsmith-layouts
1
0
Fork 0
mirror of https://github.com/vale981/metalsmith-layouts synced 2025-03-04 17:21:37 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update readme and clarify layout:false option

Browse source
This commit is contained in:
ismay 2016-02-22 16:03:09 +01:00
parent b17f7c44ec
commit fafda91e4e
2 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
Readme.md
View file

@ -102,7 +102,9 @@ Will render your layouts with swig.
### default
The default layout to use. Can be overridden with the `layout` key in each file's YAML frontmatter. If a `default` layout hasn't been specified, `metalsmith-layouts` will only process files with a `layout` option in their front-matter. Don't forget to specify the file extension. So this `metalsmith.json`:
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`:
```json
{
@ -115,7 +117,7 @@ The default layout to use. Can be overridden with the `layout` key in each file'
}
```
Will apply the `default.html` layout to all files, unless specified otherwise in the frontmatter.
Will apply the `default.html` layout to all files, unless overridden in the frontmatter.
### directory

3
lib/helpers/check.js
View file

@ -30,6 +30,7 @@ function check(files, file, pattern, def){
return false;
}
// Only process files with a specified layout
// Only process files with a specified layout or default template. Allow the
// default template to be cancelled by layout: false.
return 'layout' in data ? data.layout : def;
}