metalsmith - npm Package Compare versions

Comparing version 2.0.1 to 2.1.0

History.md

 
-2.0.1 / 2015-07-14
-==================
+2.1.0 - September 24, 2015
+--------------------------
+* cli: add support for `frontmatter` option
 
-  * meta: bumping patch because `2.0.0` was mistakenly published once before
+2.0.1 - July 14, 2015
+---------------------
+* meta: bumping patch because `2.0.0` was mistakenly published once before
 
-2.0.0 / 2015-07-14
-==================
+2.0.0 - July 14, 2015
+---------------------
+* cli: adding separate `_metalsmith` bin to allow custom transpilers
+* support: no longer supporting node 0.10 natively or in tests
 
-  * cli: adding separate `_metalsmith` bin to allow custom transpilers
-  * support: no longer supporting node 0.10 natively or in tests
-
 1.7.0 - April 30, 2015
@@ -14,0 +16,0 @@ ----------------------

package.json

 {
   "name": "metalsmith",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "license": "MIT",
@@ -5,0 +5,0 @@ "repository": "git://github.com/segmentio/metalsmith.git",

Readme.md

 
-# Metalsmith [![Build Status](https://travis-ci.org/segmentio/metalsmith.svg)](https://travis-ci.org/segmentio/metalsmith)
+# Metalsmith [![Build Status](https://travis-ci.org/segmentio/metalsmith.svg)](https://travis-ci.org/segmentio/metalsmith) [![Slack](https://img.shields.io/badge/Slack-Join%20Chat%20→-blue.svg?style=flat-square)](http://metalsmith-slack.herokuapp.com/)
 
-An extremely simple, _pluggable_ static site generator.
+> An extremely simple, _pluggable_ static site generator.
 
@@ -154,4 +154,4 @@ In Metalsmith, all of the logic is handled by plugins. You simply chain them together. Here's what the simplest blog looks like...
 [ware](https://github.com/segmentio/ware) to support middleware, so plugins
-should follow the same pattern of taking arguments of `(files, metadata, callback)`,
-modifying the `files` or `metadata` argument by reference, and then
+should follow the same pattern of taking arguments of `(files, metalsmith, callback)`,
+modifying the `files` or `metalsmith.metadata()` argument by reference, and then
 calling `callback` to trigger the next step.
@@ -181,4 +181,4 @@
 
-Ignore files from being loaded into Metalsmith. `file` can be a string,
-or an array of files. Glob syntax is supported via
+Ignore files/paths from being loaded into Metalsmith. `path` can be a string,
+or an array of paths. Glob syntax is supported via
 [minimatch](https://github.com/isaacs/minimatch).
@@ -228,2 +228,23 @@
 
+## Troubleshooting
+
+### Node Version Requirements
+Metalsmith v2.0 and above uses [generators](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Generator) which has some considerations for `node.js 0.12.x` and below.
+
+#### Using `node.js 0.10.x`
+You have two options:
+
+1. Upgrade to latest stable version of `node.js` (>= `0.12.x` — see "*Using `node.js 0.12.x`*" section below)
+2. Use Metalsmith v1.7. Put `"metalsmith": "^1.7.0"` in your `package.json` and `npm install` that version.
+
+#### Using `node.js 0.12.x`
+You have three options:
+
+1. Run `node.js` with `--harmony_generators` flag set.
+    1. `node --harmony_generators my_script.js`
+    2. Using `package.json`: `"scripts": {"start": "node --harmony_generators my_script.js"}`. Run with `npm run`
+2. `npm install` [harmonize](https://www.npmjs.com/package/harmonize) and require before Metalsmith is used. e.g. `require("harmonize")(["harmony-generators"]);`
+3. Use Metalsmith v1.7. Put `"metalsmith": "^1.7.0"` in your `package.json` and `npm install` that version.
+
+
 ## License
@@ -230,0 +251,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

27597

increased by5.36%

Number of lines in readme file

258

increased by8.86%

No dependency changes