state clearly what it means that the file is passed as a variable #89

This commit is contained in:
Frederik Dudzik 2016-05-13 18:50:01 +02:00
parent c80cc50133
commit 87967c2e4b

View file

@ -212,6 +212,14 @@ Exposes Consolidate.requires as a function.
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](https://github.com/tj/consolidate.js) for all options supported by consolidate.
## FAQ
#### Not able to render page within layout
Your page is passed to the layout as a variable and won't be interpreted as your engin's markup.
You want to convert the page before it is passed to the layout function.
[metalsmith-in-place](https://github.com/superwolff/metalsmith-in-place) is meant for that.
## Origins
This plugin is a fork of the now deprecated [metalsmith-templates](https://github.com/segmentio/metalsmith-templates). Splitting up `metalsmith-templates` into two plugins was suggested by Ian Storm Taylor. The results are: