Add pageLayouts setting to readme

foundation · Jan 31, 2016 · 958edd9 · 958edd9
1 parent 0e65dc0
commit 958edd9
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -69,6 +69,23 @@ All layouts have a special Handlebars partial called `body` which contains the c
 <!-- Footer down here -->
 ```
 
+### `pageLayouts`
+
+**Type:** `Object`
+
+A list of presets for page layouts, grouped by folder. This allows you to automatically set all pages within a certain folder to have the same layout.
+
+```js
+panini({
+  root: 'src/pages/',
+  layouts: 'src/layouts/',
+  pageLayouts: {
+    // All pages inside src/pages/blog will use the blog.html layout
+    'blog': 'blog'
+  }
+})
+```
+
 ### `partials`
 
 **Type:** `String`