@aloskutov/eleventy-plugin-external-links

v2.1.1

Published

3 months ago

Eleventy external links plugin

Downloads

715

0High
0Medium
0Low

aloskutov

11ty 11ty-plugin eleventy eleventy-plugin plugin external-links

eleventy-plugin-external-links

npms.io (quality) GitHub

Transform external links from <a href='http://external-link'> to <a href='http://external-link' rel='noreferrer nofollow noopener external' target='_blank'>.

Usage

Install via npm

npm install @aloskutov/eleventy-plugin-external-links

Load plugin in `.eleventy.js`

const externalLinks = require("@aloskutov/eleventy-plugin-external-links");

module.exports = (eleventyConfig) => {
    eleventyConfig.addPlugin(externalLinks, {'url': 'https://your-domain'});
};

Options

| Option | Type | Default | Description | |--------|------|---------|-------------| | url | string | '' | If not set, all non-relative links are considered external.| | rel | array or string | ['noreferrer', 'nofollow', 'noopener', 'external'] | link rel attribute | | target | string | _blank | link target attribute | | overwrite | boolean | true | Overwrite attribute values or not. If the value is false, then the existing attribute is not overwritten. | | excludedProtocols | array | [] | Exclude links with matching protocols from processing. The protocol must be specified without a colon. Ex. ['ftp']| | doctype | string | '' | Doctype value | | addDoctype | boolean | false | Add doctype to result or not | | ext | array | ['.html'] | Extensions | | excludedDomains | array or string | [] | For cross-linked domains and subdomains. Array or string of values separated by comma, semicolon, tab or space symbols. | | enableTarget | boolean | true | Option to enable/disable the 'target' attribute. Default value is true, i.e. target is enabled. |

Default options

{
  url: '',
  selector: 'a',
  rel: ['noreferrer', 'nofollow', 'noopener', 'external'],
  target: '_blank',
  overwrite: true,
  excludedProtocols: [],
  doctype: '<!doctype html>',
  addDoctype: false,
  ext: ['.html'],
  excludedDomains: [],
  enableTarget: true,
}

Notes

The site address can be specified without a protocol, only the fully qualified domain name. For example, www.example.com or https://www.example.com or //www.example.com

Addresses with protocols other than http, https, ftp and ftps are excluded from processing and remain unchanged.

Examples

With default values, except url

const externalLinks = require('@aloskutov/eleventy-plugin-external-links');

module.exports = (eleventyConfig, options = {}) => {
// some code

    eleventyConfig.addPlugin(externalLinks, {url: "www.example.com"});

//some code
};

Local links:

/some-link
/?link-with-query-string
#link-with-id
https://www.example.com/some-link
https://www.example.com:443/some-link
http://www.example.com/some-link
http://www.example.com:8080/some-link
ftp://www.example.com/some-link
//www.example.com/some-link
www.example.com/some-link
www.example.com

External links

http://www.google.com
http://www.google.com:80
https://www.google.com
https://www.google.com:443
ftp://www.google.com
protocol://www.google.com
//www.google.com
www.google.com

The following links are not processed

mailto:[email protected]
tel:1234567890
file:/some/file
javascript:alert(0)
telnet://192.0.2.16:80/
urn:oid:1.2.840.113549.1.1.1
sip:[email protected]
news:comp.infosystems.www.servers.unix

TODO

[x] add excludedDomains. List of addresses that will be excluded from processing. These links will not be considered external and will remain unchanged.
[x] add addDoctype. Optional doctype <!doctype html>
[x] add doctype. Doctype string. Default: <!doctype html>
[x] add ext. List of processed files, not only .html files. Default: .html
[x] support IDN (Internationalized Domain Names)
[x] add support for partial html code
[ ] further reduce the impact on the html source code

Changes

2.1.0

Added enableTarget option with default value true. If for some reason you need to disable the target attribute, set the enableTarget option to false.

This option does not break backwards compatibility.

v.2.0

Changed html parsing library from JSDOM to node-html-parser.
Increased speed of html code processing.
The addDoctype option is now, set to false.
The impact of the parsing library on the html code has been reduced. JSDOM forced wrapping in <html> if it was missing. It was not possible to work with code fragments (not wrapped in <html>).