permalink: false option

- Pass permalinks: false to a file to be ignored by the permalinks plugin

Readme.md

@@ -33,7 +33,7 @@ metalsmith.use(permalinks({
   date: 'YYYY'
 }));
 ```
-  
+
   It uses [moment.js](http://momentjs.com/docs/#/displaying/format/) to format the string.
 
 #### Relative Files
@@ -65,6 +65,21 @@ metalsmith.use(permalinks({
       css/
         style.css
 
+#### Skipping Permalinks for a file
+
+  A file can be ignored by the metalsmith-permalinks plugin if you pass the `permalink: false` option to the yaml metadata of a file.
+  This is useful for hosting a static site on AWS S3, where there is a top level `error.html` file and not an `error/index.html` file.
+
+  For example, in your error.md file:
+
+  ```js
+  ---
+  template: error.html
+  title: error
+  permalink: false
+  ---
+  ```
+
 #### CLI
 
   You can also use the plugin with the Metalsmith CLI by adding a key to your `metalsmith.json` file:

lib/index.js

@@ -37,6 +37,7 @@ function plugin(options){
       debug('checking file: %s', file);
       if (!html(file)) return;
       var data = files[file];
+      if (data['permalink'] === false) return;
       var path = replace(pattern, data, options) || resolve(file);
       var fam = family(file, files);
 

test/fixtures/backslashes/build/index.html

@@ -0,0 +1 @@
+index

test/fixtures/backslashes/build/posts/post/index.html

@@ -0,0 +1 @@
+post

test/fixtures/false-permalink/build/test/index.html

@@ -0,0 +1 @@
+test

test/fixtures/false-permalink/expected/test.html

@@ -0,0 +1 @@
+test

test/fixtures/false-permalink/src/test.html

@@ -0,0 +1,5 @@
+---
+permalink: false
+title: test
+---
+test

test/index.js

@@ -125,4 +125,14 @@ describe('metalsmith-permalinks', function(){
       });
 
   });
+
+  it('should ignore any files with permalink equal to false option', function(done){
+    Metalsmith('test/fixtures/false-permalink')
+      .use(permalinks(':title'))
+      .build(function(err){
+        if (err) return done(err);
+        equal('test/fixtures/false-permalink/expected', 'test/fixtures/false-permalink/build');
+        done();
+      });
+  });
 });