Linkify GitHub issue references
npm install linkify-issues
import {linkifyIssuesToHtml} from 'linkify-issues';
linkifyIssuesToHtml('Fixes #143 and avajs/ava#1023', {
user: 'sindresorhus',
repository: 'dofle',
attributes: {
class: 'unicorn',
multiple: ['a', 'b'],
number: 1,
exclude: false,
include: true
}
});
//=> 'Fixes <a href="https://github.com/sindresorhus/dofle/issues/143" class="unicorn" multiple="a b" number="1" include>#143</a> and <a href="https://github.com/avajs/ava/issues/1023" class="unicorn" multiple="a b" number="1" include>avajs/ava#1023</a>'
import {linkifyIssuesToMarkdown} from 'linkify-issues';
linkifyIssuesToMarkdown('Fixes #143 and avajs/ava#1023', {
user: 'sindresorhus',
repository: 'dofle'
});
//=> 'Fixes [#143](https://github.com/sindresorhus/dofle/issues/143) and [avajs/ava#1023](https://github.com/avajs/ava/issues/1023)'
import {linkifyIssuesToDom} from 'linkify-issues';
const fragment = linkifyIssuesToDom('See #143', {
user: 'sindresorhus',
repository: 'dofle',
attributes: {
class: 'unicorn',
}
});
document.body.appendChild(fragment);
Returns an HTML string like 'See <a href="https://github.com/sindresorhus/dofle/issues/143">#143</a>'.
Type: string
A string with issue references to linkify.
Type: object
Required
Type: string
GitHub user.
Required
Type: string
GitHub repository.
Type: object
HTML attributes to add to the link.
Type: string
Default: 'https://github.com'
The base URL.
Type: string | undefined
Default: 'GH-'
Additional reference prefix to support. It can be set to undefined to disable the default.
linkifyIssuesToHtml('Will not linkify GH-123', {
user: 'sindresorhus',
repository: 'dofle',
additionalPrefix: undefined
});
// => 'Will not linkify GH-123'
linkifyIssuesToHtml('Will link SOUP:235 but not GH-123', {
user: 'sindresorhus',
repository: 'dofle',
additionalPrefix: 'SOUP:'
});
// => 'Will link <a href="https://github.com/sindresorhus/dofle/issues/235">SOUP:235</a> but not GH-123'
[!NOTE] The prefix is added unescaped to the regex, keep it simple.
Returns a Markdown string like 'See [#143](https://github.com/sindresorhus/dofle/issues/143)'.
Type: string
A string with issue references to linkify.
See options above.
Returns a DocumentFragment ready to be appended in a DOM safely, like DocumentFragment(TextNode('See '), HTMLAnchorElement('#143')).
This only works in the browser.
See options above.