5.1.0

Added

• Promise interface for transcludeString() and transcludeFile() when requiring hercule/promises. @realityking

5.0.0

Removed

• Removed support for Node.js 8.x

4.1.0

Added

• Add placeholder argument to resolver API allowing resolver functions to pass the unmodified content back and skip the link. This allows the default behaviour where unresolvable links throw an error to be overridden with a best-effort approach.

4.0.1

Fixed

• Stack size error caused by a function that returned synchronously in some cases. Files with a thousands of line between transclusion could cause hercule to crash.

4.0.0

Added

• New support for alternative transclusion syntaxes including aglio, marked, and multimarkdown through both library and command line interface.
• Command line interface requires input to be explicitly specified, including stdin using - or --stdin.
• transcludeString() accepts a source option, replacing the relativePath option.
• TranscludeStream(), transcludeString(), and transcludeFile() accept a resolvers option allowing an array of functions to be provided for resolving URL's to input. For example, this could be used to support resolving secured HTTP content or resolving local links within a browser. Please refer to the Resolvers documentation.
• TranscludeStream() emits a sourcemap event exactly once with the sourcemap object attached.
• transcludeString() and transcludeFile() return a sourcemap as the third callback argument. A list of source paths can be extracted from the object.

Changed

• TranscludeStream() now requires a source is specified.
• TranscludeStream() and transcludeFile() now resolve transclusion links will relative to the specified source.

Removed

• TranscludeStream(), transcludeString(), and transcludeFile() no longer support relativePath option.
• transcludeString() and transcludeFile() no longer return an array of source paths as the third callback argument.

3.0.0

Improvements

• Errors are now handled consistent with the API style: streams emit errors, async error-first callback, sync throws.

2.0.5

Highlights

• Fixes issue where some optional arguments were incorrectly being required. (#180)

Note: CLI argument --relative has been renamed --relativePath for consistency.

2.0.4

Highlights

• Upgrade dependencies: [email protected] and [email protected].
• Simplified Travis build matrix and improved commit message linting.

2.0.3

Highlights

• Fixed: regression in handling of override and fallback relative file paths. (#151)

2.0.2

Highlights

• Improvement: added json and json-err reporter options for bunyan output to stdout and stderr respectively. (#149)
• Fixed: regression in handling of relative file paths. (#147)