Add target and rel attributes to external links with remark.
Installation
npm:
npm install remark-external-links
Usage
Say we have the following file, example.js
:
var html = require('remark-html')
var remark = require('remark')
var externalLinks = require('remark-external-links')
remark()
.use(externalLinks, {target: false, rel: ['nofollow']})
.use(html)
.process('[remark](https://github.com/remarkjs/remark)', function(err, file) {
if (err) throw err
console.log(String(file))
})
Now, running node example
yields:
<p><a href="https://github.com/remarkjs/remark" rel="nofollow">remark</a></p>
API
Add target and rel attributes to external links.
options.target
How to display referenced documents (string?
: _self
, _blank
, _parent
,
or _top
, default: _blank
).
Pass false
to not set target
s on links.
options.rel
Link types to hint about the referenced documents
(Array.<string>
or string
, default: ['nofollow', 'noopener', 'noreferrer']
).
Pass false
to not set rel
s on links.
When using a target
, add noopener
and noreferrer
to avoid
exploitation of the window.opener
API.
options.protocols
Allows additional protocols to be checked; such as mailto:
, tel:
, etc.
(Array.<string>
, default: ['http', 'https']
).
Contribute
See contributing.md
in remarkjs/remark
for ways to get
started.
This organisation has a Code of Conduct. By interacting with this
repository, organisation, or community you agree to abide by its terms.
License
MIT © Cédric Delpoux