Package Exports

esdoc-plugin-external-links

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (esdoc-plugin-external-links) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

esdoc-plugin-external-links

ESDoc plugin to set the target for external links

Installation

npm install --save-dev esdoc-plugin-external-links

Usage

Add the esdoc-plugin-external-links to your ESDoc config...

{
  ...
  "plugins": [
    {
      "name": "esdoc-plugin-external-links",
      "option": ...
    }
  ]
}

Options

The option property can either be an Object...

{
  ...
  "plugins": [
    {
      "name": "esdoc-plugin-external-links",
      "option": {
        ...
      }
    }
  ]
}

or an Array<Object>...

{
  ...
  "plugins": [
    {
      "name": "esdoc-plugin-external-links",
      "option": [
        { ... },
        { ... }
      ]
    }
  ]
}

If you provide an Array, each option object within that array will be applied sequentially.

Available Options

Option	Behavior	Default
`includes`	An `Array<String>` or `String` of glob patterns to include	`*/.html`
`excludes`	An `Array<String>` or `String` of glob patterns to exclude
`query`	The selector quuery to find external links	`a[href^="http://"], a[href^="https://"], a[href^="//"], a[href][ref*="external"]`
`target`	The `target` attribute to set on the anchor	`_blank`