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
Automatically adds the target and rel attributes to external links.
npm install remark-external-links --save
yarn add remark-external-links
remark-external-links is designed to work with remark-html. It add the target and rel attributes to external links.
var externalLinks = require("remark-external-links")
var html = require("remark-html")
var remark = require("remark")
// OR
import externalLinks from "remark-external-links"
import html from "remark-html"
import remark from "remark"
remark()
.use(externalLinks, {
target: null,
rel: "nofollow",
})
.use(html)
.process("[remark](https://github.com/gnab/remark)")
// yield
// <p><a href="https://github.com/gnab/remark" rel="nofollow">remark</a></p>
Note that this module must be included before remark-html.
Type: string
Default: _blank
Specifies where to display the linked URL.
The value should be on of : _self, _blank, _parent, _top
You can specify null to do not add the target attribute to your links
Type: string
Default: nofollow noopener noreferrer
Specifies the relationship of the target object to the link object. The value is a space-separated list of link types.
You can specify null to do not add the rel attribute to your links
See changelog
Pull requests are welcome. If you add functionality, then please add unit tests to cover it.
lib foldernpm run clean
lib foldernpm run build
src foldernpm run lint
src foldernpm run test
MIT
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
Ecma TC39 is meeting this week and has moved key ECMAScript proposals forward, advancing Deferred Import Evaluation, Error.isError(), RegExp Escaping, and Promise.try to the next stages.
Security News
Researchers have demonstrated that teams of LLM agents can exploit zero-day vulnerabilities with a 53% success rate, and the costs of using AI to do so are rapidly becoming more affordable than hiring a human penetration tester.
Security News
In an unprecedented surge, May 2024 saw the publication of over 5,000 CVEs, marking a historic milestone in cybersecurity with an average of 164 CVEs per day, nearly double the 2023 daily average.