remark-external-links
Advanced tools
Package description
The remark-external-links package is a plugin for the Remark Markdown processor that automatically modifies links in Markdown files. It is primarily used to add attributes like target and rel to external links, enhancing security and usability without manual HTML tagging.
Adding attributes to external links
This feature allows users to automatically add specific attributes such as target='_blank' and rel='nofollow noopener noreferrer' to external links in Markdown content. This enhances security by preventing tabnapping and improves SEO through 'nofollow'. The code sample demonstrates how to set up the plugin with Remark to process a simple Markdown string.
const remark = require('remark');
const html = require('remark-html');
const externalLinks = require('remark-external-links');
remark()
.use(externalLinks, {target: '_blank', rel: ['nofollow', 'noopener', 'noreferrer']})
.use(html)
.process('Check out [Google](https://google.com)!', function (err, file) {
console.log(String(file));
});Similar to remark-external-links, rehype-external-links is a plugin but for Rehype, which processes HTML instead of Markdown. It offers similar functionalities in terms of adding attributes to external links in HTML content, making it a suitable alternative for projects that work directly with HTML rather than Markdown.
This is a plugin for the markdown-it parser, which is another popular Markdown processor. Like remark-external-links, it allows the addition of attributes to external links in Markdown files. The main difference lies in the base Markdown processor (markdown-it vs. remark), which might affect the choice depending on other project dependencies and personal preference for Markdown syntax extensions.
Readme
remark plugin to automatically add target and rel attributes
to external links.
This plugin is ready for the new parser in remark
(remarkjs/remark#536).
The current and previous versions of the plugin work with the current and
previous versions of remark.
npm:
npm install remark-external-links
Say we have the following file, example.js:
var remark = require('remark')
var html = require('remark-html')
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>
remark().use(externalLinks[, options])Automatically add target and rel attributes to external links.
optionsoptions.targetHow to display referenced documents (string?: _self, _blank, _parent,
or _top, default: _blank).
Pass false to not set targets on links.
options.relLink types to hint about the referenced documents (Array.<string>
or string, default: ['nofollow', 'noopener', 'noreferrer']).
Pass false to not set rels on links.
When using a
target, addnoopenerandnoreferrerto avoid exploitation of thewindow.openerAPI.
options.protocolsProtocols to check, such as mailto or tel (Array.<string>, default:
['http', 'https']).
options.contenthast content to insert at the end of external links
(Node or Children).
Will be inserted in a <span> element.
Useful for improving accessibility by giving users advanced warning when opening a new window.
options.contentPropertiesProperties to add to the span wrapping content, when
given.
options.content is used and injected into the tree when it’s given.
This could open you up to a cross-site scripting (XSS) attack if you pass
user provided content in.
This may become a problem if the Markdown later transformed to rehype (hast) or opened in an unsafe Markdown viewer.
Most likely though, this plugin will instead protect you from exploitation of
the window.opener API.
See contributing.md in remarkjs/.github for ways
to get started.
See support.md for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
FAQs
Legacy remark plugin to automatically add target and rel attributes to external links — please use `rehype-external-links`
We found that remark-external-links demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.