Jump To

• General Installation
  • Node.js module
  • Browser globals

Plugins

Plugins provide no new interfaces but add additional detection functionality to Linkify. A custom plugin API is currently in the works.

Plugins are available for the following link types:

• Twitter-style hashtags
• ”@” Mentions
• GitHub-style ticket/issue numbers
• IP Addresses
• Arbitrary keywords

General Installation

In the following instructions, substitute [PLUGIN] with the plugin you wish to install, e.g., hashtag, mention or ticket.

Node.js module

Install from the command line with NPM

npm install linkifyjs linkify-plugin-[PLUGIN]

const linkify = require("linkifyjs");
require("linkify-plugin-[PLUGIN]");

or with ES6 modules

import * as linkify from "linkifyjs";
import "linkify-plugin-[PLUGIN]";

Browser globals

Download linkify and extract the contents into your website’s assets directory. Include the following scripts in your HTML:

<script src="linkify.js"></script>
<script src="linkify-plugin-[PLUGIN].js"></script>