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

Browse source
This commit is contained in:
ismay 2016-02-14 15:31:03 +01:00
parent 81cdcc0ef0
commit cc81f7ccfe
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
Readme.md
View file

@ -82,6 +82,7 @@ You can pass options to `metalsmith-layouts` with the [Javascript API](https://g
* [directory](#directory): directory for the layouts, layouts by default (optional)
* [partials](#partials): directory for the partials (optional)
* [pattern](#pattern): only files that match this pattern will be processed (optional)
* [rename](#rename): change the file extension of processed files to `.html` (optional)
### engine
@ -169,6 +170,23 @@ Only files that match this pattern will be processed. So this `metalsmith.json`:
Would only process files that have the `.md` extension.
### rename
Change the file extension of processed files to `.html` (optional). This option is set to `false` by default. So for example this `metalsmith.json`:
```json
{
"plugins": {
"metalsmith-in-place": {
"engine": "handlebars",
"rename": true
}
}
}
```
Would rename the extensions of all processed files to `.html`.
### Consolidate
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.