Jump To

• Installation
  • Node.js module
  • Browser globals
• Usage

Linkify #-Ticket Plugin

Adds basic support for GitHub-style tickets/issues.

Installation

Node.js module

Install from the command line with NPM

npm install linkifyjs linkify-plugin-ticket

const linkify = require("linkifyjs");
require("linkify-plugin-ticket");

or with ES6 modules

import * as linkify from "linkifyjs";
import "linkify-plugin-ticket";

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-ticket.js"></script>

Usage

Use the formatHref option with your preferred interface to correctly resolve a ticket. Example linking to GitHub issues with linkifyHtml:

const options = {
  formatHref: {
    ticket: (href) =>
      "https://github.com/Hypercontext/linkifyjs/issues/" + href.substr(1),
  },
};

// With linkify-html
linkifyHtml("This is related to #42.", options);

// With linkify-react
<Linkify options={options}>This is related to #42.</Linkify>

The last line returns the following string:

'This is related to <a href="https://github.com/Hypercontext/linkifyjs/issues/42">#42</a>.';