linkify-gh-usernames
v2.0.0
Published
Linkify GitHub usernames
Downloads
6
Maintainers
Readme
linkify-gh-usernames
Linkify GitHub usernames
Install
[!NOTE] This package is ESM only.
$ npm install linkify-gh-usernames
Usage
import linkifyUsernames from "linkify-gh-usernames";
linkifyUsernames(
"Hi @yeskunall and welcome to the @21kb org! Feel free to look around!",
{
attributes: {
class: "github",
target: "_blank",
},
},
);
//=> 'Hi <a href="https://github.com/yeskunall" class="github" target="_blank">@yeskunall</a> and welcome to the <a href="https://github.com/21kb" class="github" target="_blank">@21kb</a> org! Feel free to look around!
API
linkifyUsernames(input, [options])
input
Type: string
Text containing valid GitHub username.
options
Type: Object
attributes
Type: Object
HTML attributes to add to the link.
value
Type: string
Default: The URL
Set a custom HTML value for the link.
Related
- linkify-issues - Linkify GitHub issue references
- linkify-urls - Linkify URLs in text