@package module

Adds the package's package.json info to the DocObject.

@package PATH

Once added to the DocObject, you can reference the package.json properties like name, description, author, etc in .mustache templates.

Parameters

  1. PATH {String}:

    The path to a package.json file.

An example package.json file might look like:

{
  "name": "my-package",
  "version": "0.0.1",
  "description": "My cool package.",
}

That gets used like:

@package ./demos/package.json