.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.eslintrc

@@ -0,0 +1,26 @@
+root: true
+
+env:
+  node: true
+  es6: true
+
+parserOptions:
+  ecmaVersion: 2018
+  sourceType: module
+  ecmaFeatures:
+    globalReturn: true
+    impliedStrict: true
+
+extends:
+  - "eslint:recommended"
+  - prettier
+
+plugins:
+  - prettier
+
+rules:
+  "prettier/prettier": error
+  camelcase: 0
+  no-console: 1
+  quotes: [2, "single", "avoid-escape"]
+  valid-jsdoc: [1, {requireParamDescription: false, requireReturnDescription: false}]

.prettierignore

@@ -0,0 +1,2 @@
+package-lock.json
+package.json

.prettierrc

@@ -0,0 +1,2 @@
+singleQuote: true
+printWidth: 120

History.md

@@ -1,21 +1,34 @@
+# Latest
+## 1.0.0 / 2018-07-17
 
-0.2.2 / 2018-01-09
-==================
+* Fixed API
+* Upgraded to Marked 0.4.0 #31
+* Fixed security issue with Buffer #29
+* Ensure key is string #24
+* Cross platform path separators (Windows) #16
+* Strict file endings #10
+* Allow missing keys #9
+* Docs: Usage with highlighting lib #6
+* Updated all packages
+
+# Previous
+
+## 0.2.2 / 2018-01-09
 
 * update marked dependency to fix security issue
 
-0.2.1 - February 6, 2013
-------------------------
+## 0.2.1 - February 6, 2013
+
 * add debug statements
 
-0.2.0 - February 5, 2013
-------------------------
+## 0.2.0 - February 5, 2013
+
 * update to use buffers for metalsmith 0.1.0
 
-0.1.0 - February 5, 2013
-------------------------
+## 0.1.0 - February 5, 2013
+
 * add `keys` option
 
-0.0.1 - February 4, 2013
+## 0.0.1 - February 4, 2013
 ------------------------
 :sparkles:

Readme.md

@@ -1,23 +1,35 @@
-
 # metalsmith-markdown
 
-  A Metalsmith plugin to convert markdown files.
+[![npm version][npm-badge]][npm-url]
+[![code style: prettier][prettier-badge]][prettier-url]
+[![metalsmith: core plugin][metalsmith-badge]][metalsmith-url]
+
+[![Known Vulnerabilities][snyk-badge]][synk-url]
+
+A Metalsmith plugin to convert markdown files.
 
 ## Installation
 
-    $ npm install metalsmith-markdown
+```bash
+$ npm install metalsmith-markdown
+```
 
 ## CLI Usage
 
-  Install via npm and then add the `metalsmith-markdown` key to your `metalsmith.json` plugins with any [Marked](https://github.com/chjj/marked) options you want, like so:
+  Install via npm and then add the `metalsmith-markdown` key to your `metalsmith.json` plugins with any [Marked](https://github.com/markedjs/marked) options you want, like so:
 
 ```json
 {
   "plugins": {
     "metalsmith-markdown": {
-      "smartypants": true,
+      "pedantic": false,
       "gfm": true,
-      "tables": true
+      "tables": true,
+      "breaks": false,
+      "sanitize": false,
+      "smartLists": true,
+      "smartypants": false,
+      "xhtml": false
     }
   }
 }
@@ -29,14 +41,37 @@
 
 ```js
 var markdown = require('metalsmith-markdown');
+var highlighter = require('highlighter');
 
 metalsmith.use(markdown({
-  smartypants: true,
+  renderer: new myMarked.Renderer(),
+  highlight: function(code) {
+    return require('highlight.js').highlightAuto(code).value;
+  },
+  pedantic: false,
   gfm: true,
-  tables: true
+  tables: true,
+  breaks: false,
+  sanitize: false,
+  smartLists: true,
+  smartypants: false,
+  xhtml: false
 }));
 ```
 
+## History
+
+[History](./History.md#Latest)
+
 ## License
 
-  MIT
+MIT
+
+[npm-badge]: https://img.shields.io/npm/v/metalsmith-markdown.svg
+[npm-url]: https://www.npmjs.com/package/metalsmith-markdown
+[prettier-badge]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?longCache=true
+[prettier-url]: https://github.com/prettier/prettier
+[metalsmith-badge]: https://img.shields.io/badge/metalsmith-core_plugin-green.svg?longCache=true
+[metalsmith-url]: http://metalsmith.io
+[snyk-badge]: https://snyk.io/test/github/segmentio/metalsmith-markdown/badge.svg?targetFile=package.json
+[synk-url]: https://snyk.io/test/github/segmentio/metalsmith-markdown?targetFile=package.json

lib/index.js

@@ -1,15 +1,19 @@
-
 var basename = require('path').basename;
 var debug = require('debug')('metalsmith-markdown');
 var dirname = require('path').dirname;
 var extname = require('path').extname;
+var join = require('path').join;
 var marked = require('marked');
 
 /**
- * Expose `plugin`.
+ * Check if a `file` is markdown.
+ *
+ * @param {String} file
+ * @return {Boolean}
  */
-
-module.exports = plugin;
+var markdown = function(file) {
+  return /\.md$|\.markdown$/.test(extname(file));
+};
 
 /**
  * Metalsmith plugin to convert markdown files.
@@ -18,41 +22,40 @@ module.exports = plugin;
  *   @property {Array} keys
  * @return {Function}
  */
-
-function plugin(options){
+var plugin = function(options) {
   options = options || {};
   var keys = options.keys || [];
 
-  return function(files, metalsmith, done){
+  return function(files, metalsmith, done) {
     setImmediate(done);
-    Object.keys(files).forEach(function(file){
+    Object.keys(files).forEach(function(file) {
       debug('checking file: %s', file);
       if (!markdown(file)) return;
       var data = files[file];
       var dir = dirname(file);
       var html = basename(file, extname(file)) + '.html';
-      if ('.' != dir) html = dir + '/' + html;
+      if ('.' != dir) html = join(dir, html);
 
       debug('converting file: %s', file);
       var str = marked(data.contents.toString(), options);
-      data.contents = new Buffer(str);
+      try {
+        // preferred
+        data.contents = Buffer.from(str);
+      } catch (err) {
+        // node versions < (5.10 | 6)
+        data.contents = new Buffer(str);
+      }
       keys.forEach(function(key) {
-        data[key] = marked(data[key], options);
+        if (data[key]) {
+          data[key] = marked(data[key].toString(), options);
+        }
       });
 
       delete files[file];
       files[html] = data;
     });
   };
-}
+};
 
-/**
- * Check if a `file` is markdown.
- *
- * @param {String} file
- * @return {Boolean}
- */
-
-function markdown(file){
-  return /\.md|\.markdown/.test(extname(file));
-}
+// Expose Plugin
+module.exports = plugin;