- Linkify
- {%if page.showbyhypercontext %}
-
- a JS plugin by {% include hypercontext-logo.svg %}
+
+ Linkify
+
+ {%if page.showsubtitle %}
+
+ a JavaScript plugin
{% endif %}
{%if layout.subtitle %}
-
+
{{ layout.subtitle }}
{% endif %}
diff --git a/_includes/hypercontext-logo.svg b/_includes/hypercontext-logo.svg
deleted file mode 100644
index 389e16bf..00000000
--- a/_includes/hypercontext-logo.svg
+++ /dev/null
@@ -1,3 +0,0 @@
-
diff --git a/_includes/icon-hypercontext.html b/_includes/icon-hypercontext.html
deleted file mode 100644
index 93d8d103..00000000
--- a/_includes/icon-hypercontext.html
+++ /dev/null
@@ -1,5 +0,0 @@
-
-
-
diff --git a/css/main.scss b/css/main.scss
index 52dbf0c5..23b8eb2b 100755
--- a/css/main.scss
+++ b/css/main.scss
@@ -1,49 +1,73 @@
---
---
+
@charset "utf-8";
@font-face {
- font-family: 'Nunito Sans';
+ font-family: "Nunito Sans";
font-style: normal;
font-weight: 400;
font-display: swap;
- src: local('Nunito Sans Regular'), local('NunitoSans-Regular'), url(https://fonts.gstatic.com/s/nunitosans/v6/pe0qMImSLYBIv1o4X1M8cce9I9tAcVwo.woff2) format('woff2');
- unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
+ src:
+ local("Nunito Sans Regular"),
+ local("NunitoSans-Regular"),
+ url(https://fonts.gstatic.com/s/nunitosans/v6/pe0qMImSLYBIv1o4X1M8cce9I9tAcVwo.woff2)
+ format("woff2");
+ unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA,
+ U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215,
+ U+FEFF, U+FFFD;
}
@font-face {
- font-family: 'Nunito Sans';
+ font-family: "Nunito Sans";
font-style: normal;
font-weight: 600;
font-display: swap;
- src: local('Nunito Sans SemiBold'), local('NunitoSans-SemiBold'), url(https://fonts.gstatic.com/s/nunitosans/v6/pe03MImSLYBIv1o4X1M8cc9iB85tU1ECVZl_.woff2) format('woff2');
- unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
+ src:
+ local("Nunito Sans SemiBold"),
+ local("NunitoSans-SemiBold"),
+ url(https://fonts.gstatic.com/s/nunitosans/v6/pe03MImSLYBIv1o4X1M8cc9iB85tU1ECVZl_.woff2)
+ format("woff2");
+ unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA,
+ U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215,
+ U+FEFF, U+FFFD;
}
@font-face {
- font-family: 'Poppins';
+ font-family: "Poppins";
font-style: normal;
font-weight: 400;
font-display: swap;
- src: local('Poppins Regular'), local('Poppins-Regular'), url(https://fonts.gstatic.com/s/poppins/v13/pxiEyp8kv8JHgFVrJJfecnFHGPc.woff2) format('woff2');
- unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
+ src:
+ local("Poppins Regular"),
+ local("Poppins-Regular"),
+ url(https://fonts.gstatic.com/s/poppins/v13/pxiEyp8kv8JHgFVrJJfecnFHGPc.woff2)
+ format("woff2");
+ unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA,
+ U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215,
+ U+FEFF, U+FFFD;
}
@font-face {
- font-family: 'Poppins';
+ font-family: "Poppins";
font-style: normal;
font-weight: 700;
font-display: swap;
- src: local('Poppins Bold'), local('Poppins-Bold'), url(https://fonts.gstatic.com/s/poppins/v13/pxiByp8kv8JHgFVrLCz7Z1xlFd2JQEk.woff2) format('woff2');
- unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
+ src:
+ local("Poppins Bold"),
+ local("Poppins-Bold"),
+ url(https://fonts.gstatic.com/s/poppins/v13/pxiByp8kv8JHgFVrLCz7Z1xlFd2JQEk.woff2)
+ format("woff2");
+ unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA,
+ U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215,
+ U+FEFF, U+FFFD;
}
// Our variables
-$font-family-sans-serif: 'Nunito Sans', sans-serif;
+$font-family-sans-serif: "Nunito Sans", sans-serif;
$headings-font-family: Poppins, Arial, sans-serif;
$font-family-monospace: Monaco, Consolas, "Courier New", monospace;
$font-weight-bold: 600;
$font-weight-bolder: 600;
$headings-font-weight: 700;
-
// Brand colours
$blue: #108cff;
$pink: #ffa2b2;
@@ -73,11 +97,13 @@ a {
}
}
-.btn, .btn:hover {
+.btn,
+.btn:hover {
text-decoration: none;
}
-.btn-primary, .btn-primary:hover {
+.btn-primary,
+.btn-primary:hover {
color: white;
}
@@ -91,14 +117,6 @@ a {
padding-bottom: 2em;
}
-.hypercontext-logo {
- display: inline;
-
- path {
- fill: var(--bs-dark);
- }
-}
-
#page-title {
line-height: 1;
}
diff --git a/docs/linkifyjs.md b/docs/linkifyjs.md
index 71cfdd5a..0b8003b8 100644
--- a/docs/linkifyjs.md
+++ b/docs/linkifyjs.md
@@ -144,7 +144,7 @@ before invoking linkify for the first time.
**Caution:** The plugin development API is in its very early stages and only supports very basic plugins. Updated features, APIs, and docs are in progress.
-Check out the sample [Hashtag plugin](https://github.com/Hypercontext/linkifyjs/blob/main/packages/linkify-plugin-hashtag/src/hashtag.js) for an example. Check out the [Keyword plugin](https://github.com/Hypercontext/linkifyjs/blob/main/packages/linkify-plugin-keyword/src/keyword.js) for more advanced usage.
+Check out the sample [Hashtag plugin](https://github.com/mfrasser/linkifyjs/blob/main/packages/linkify-plugin-hashtag/src/hashtag.js) for an example. Check out the [Keyword plugin](https://github.com/nfrasser/linkifyjs/blob/main/packages/linkify-plugin-keyword/src/keyword.js) for more advanced usage.
### linkify.test _(str [, type])_
diff --git a/docs/options.md b/docs/options.md
index b824c3b5..6c772afd 100644
--- a/docs/options.md
+++ b/docs/options.md
@@ -169,7 +169,7 @@ etc.) and each value is the formatting function to use for that type.
}
return value;
},
- }
+ },
);
// or
@@ -179,7 +179,7 @@ etc.) and each value is the formatting function to use for that type.
format: {
url: (value) => (value.length > 50 ? value.slice(0, 50) + "…" : value),
},
- }
+ },
);
```
@@ -201,7 +201,7 @@ etc.) and each value is the formatting function to use for that type.
"This site is #rad".linkify({
formatHref: function (href, type) {
if (type === "hashtag") {
- href = "https://twitter.com/hashtag/" + href.substring(1);
+ href = "https://bsky.app/hashtag/" + href.substring(1);
}
return href;
},
@@ -235,14 +235,18 @@ linkifyHtml(
"but do b.ca",
{
ignoreTags: ["script", "style"],
- }
+ },
);
```
Returns
```html
-Please ignore
+Please ignore
+
but do b.ca
```
@@ -403,7 +407,7 @@ Applies to the result of the [`format` option](#format), if also specified.
"http://github.com/{{ site.github_username }}/search/?q=this+is+a+really+long+query+string".linkify(
{
truncate: 42,
- }
+ },
);
```
diff --git a/docs/plugin-hashtag.md b/docs/plugin-hashtag.md
index 7e557356..9172aa06 100644
--- a/docs/plugin-hashtag.md
+++ b/docs/plugin-hashtag.md
@@ -6,7 +6,7 @@ toc: true
# Linkify #Hashtag Plugin
-Adds basic support for Twitter-style hashtags.
+Adds basic support for #-hashtags.
## Installation
@@ -44,13 +44,13 @@ Include the following scripts in your HTML:
## Usage
Use the `formatHref` option with your preferred [interface](interfaces.html) to
-correctly resolve a hashtag. Example linking to Twitter hashtags with
+correctly resolve a hashtag. Example linking to social media hashtags with
`linkifyHtml`:
```jsx
const options = {
formatHref: {
- hashtag: (href) => "https://twitter.com/hashtag/" + href.substr(1),
+ hashtag: (href) => "https://bsky.app/hashtag/" + href.substr(1),
},
};
@@ -58,11 +58,13 @@ const options = {
linkifyHtml("Works with hashtags #PhotoOfTheDay or #일상", options);
// With linkify-react
-Works with hashtags #PhotoOfTheDay or #일상
+
+ Works with hashtags #PhotoOfTheDay or #일상
+ ;
```
The last line returns the following string:
```js
-'Works with hashtags #PhotoOfTheDay or #일상';
+'Works with hashtags #PhotoOfTheDay or #일상';
```
diff --git a/docs/plugin-mention.md b/docs/plugin-mention.md
index 083bd936..b5ce9f1c 100644
--- a/docs/plugin-mention.md
+++ b/docs/plugin-mention.md
@@ -6,7 +6,7 @@ toc: true
# Linkify @Mention Plugin
-Adds basic support for Twitter- and GitHub- style "at"-mentions.
+Adds basic support for @-mentions.
## Installation
@@ -59,14 +59,14 @@ const options = {
};
// With linkify-html
-linkifyHtml("Check out @Hypercontext and @nfrasser", options);
+linkifyHtml("Check out @cryoem-uoft and @nfrasser", options);
// With linkify-react
-Check out @Hypercontext and @nfrasser
+Check out @cryoem-uoft and @nfrasser ;
```
The last line returns the following string:
```js
-'Check out @Hypercontext and @nfrasser';
+'Check out @cryoem-uoft and @nfrasser';
```
diff --git a/docs/plugin-ticket.md b/docs/plugin-ticket.md
index c0407063..477013e0 100644
--- a/docs/plugin-ticket.md
+++ b/docs/plugin-ticket.md
@@ -51,7 +51,7 @@ correctly resolve a ticket. Example linking to GitHub issues with
const options = {
formatHref: {
ticket: (href) =>
- "https://github.com/Hypercontext/linkifyjs/issues/" + href.substr(1),
+ "https://github.com/nfrasser/linkifyjs/issues/" + href.substr(1),
},
};
@@ -59,11 +59,11 @@ const options = {
linkifyHtml("This is related to #42.", options);
// With linkify-react
-This is related to #42.
+This is related to #42. ;
```
The last line returns the following string:
```js
-'This is related to #42.';
+'This is related to #42.';
```
diff --git a/docs/plugins.md b/docs/plugins.md
index 4f23b6b6..570d4aa6 100644
--- a/docs/plugins.md
+++ b/docs/plugins.md
@@ -11,7 +11,7 @@ Linkify. A custom plugin API is currently in the works.
Plugins are available for the following link types:
-- [Twitter-style hashtags](plugin-hashtag.html)
+- ["#" hashtags](plugin-hashtag.html)
- ["@" Mentions](plugin-mention.html)
- [GitHub-style ticket/issue numbers](plugin-ticket.html)
- [IP Addresses](plugin-ip.html)
diff --git a/docs/v2/2.1.md b/docs/v2/2.1.md
index 9bef044e..96a1cd6d 100644
--- a/docs/v2/2.1.md
+++ b/docs/v2/2.1.md
@@ -12,27 +12,29 @@ improvements. You can read the full CHANGELOG [on GitHub](https://github.com/{{
## BREAKING CHANGES
-* The `dist/jquery.linkify.js` 1.x legacy browser files have been permanently
-removed from the release bundle.
- * Use `linkify.js` and `linkify-jquery.js` instead.
-* The deprecated `newLine` option from linkify 1.x has been completely removed.
- * Use the [`nl2br` option](options.html#nl2br) instead.
+- The `dist/jquery.linkify.js` 1.x legacy browser files have been permanently
+ removed from the release bundle.
+ - Use `linkify.js` and `linkify-jquery.js` instead.
+- The deprecated `newLine` option from linkify 1.x has been completely removed.
+ - Use the [`nl2br` option](options.html#nl2br) instead.
### Deprecations
-* The `linkAttributes` option is deprecated in favour of just **`attributes`**.
-* The `linkClass` option is deprecated in favour of **`className`**.
-* The default `.linkified` class is deprecated and will be fully removed
-in a future release.
+- The `linkAttributes` option is deprecated in favour of just **`attributes`**.
+- The `linkClass` option is deprecated in favour of **`className`**.
+- The default `.linkified` class is deprecated and will be fully removed
+ in a future release.
To maintain compatibility with versions >= 2.1, make sure options objects
include these properties instead of `linkAttributes` and `linkClass`
```js
options = {
- attributes: {/* */}, // instead of `linkAttributes`
- className: 'linkified', // instead of `linkClass`. Apply default linkClass
-}
+ attributes: {
+ /* */
+ }, // instead of `linkAttributes`
+ className: "linkified", // instead of `linkClass`. Apply default linkClass
+};
```
## React.js Interface
@@ -78,9 +80,8 @@ This renders the following HTML
Check out my profile at
- github.com/nfrasser
- .
- It's #rad.
+ github.com/nfrasser . It's #rad.
```
@@ -93,13 +94,13 @@ Linkify (finally!) has first-class support for #tickets (think GitHub issue
references) and @mentions.
```js
-const linkify = require('linkifyjs');
-const linkifyStr = require('linkifyjs/string');
+const linkify = require("linkifyjs");
+const linkifyStr = require("linkifyjs/string");
-require('linkifyjs/plugins/mention')(linkify);
-require('linkifyjs/plugins/ticket')(linkify);
+require("linkifyjs/plugins/mention")(linkify);
+require("linkifyjs/plugins/ticket")(linkify);
-let linkified = linkifyStr('Hey @mdo, check out issue #42!');
+let linkified = linkifyStr("Hey @mdo, check out issue #42!");
console.log(linkified);
```
@@ -128,15 +129,15 @@ You can now specify man of linkify's formatting options with objects where each
key is a type of detectable link:
```js
-$('p').linkify({
+$("p").linkify({
formatHref: {
- hashtag: (val) => 'https://twitter.com/hashtag' + val.substr(1),
- mention: (val) => '/users' + val
+ hashtag: (val) => "https://bsky.app/hashtag" + val.substr(1),
+ mention: (val) => "/users" + val,
},
validate: {
url: (val) => /^https?:\/\//.test(val), // only allow URLs that begin with a protocol
- email: false // don't linkify emails
- }
+ email: false, // don't linkify emails
+ },
});
```
@@ -151,18 +152,17 @@ If you application calls linkify multiple times with the same options, you
can now specify those options when your app loads, before calling linkify.
```js
-const linkify = require('linkifyjs');
-linkify.options.defaults.defaultProtocol = 'https';
+const linkify = require("linkifyjs");
+linkify.options.defaults.defaultProtocol = "https";
// ...
-const linkifyHtml = require('linkifyjs/html');
-let result = linkifyHtml('//amazon.ca');
+const linkifyHtml = require("linkifyjs/html");
+let result = linkifyHtml("//amazon.ca");
console.log(result); // https://amazon.ca
```
-
-***
+---
Check out the complete CHANGELOG [on
GitHub](https://github.com/{{ site.github_username }}/blob/master/CHANGELOG.md#2.1.0).
diff --git a/docs/v2/options.md b/docs/v2/options.md
index eef33b57..333e0401 100644
--- a/docs/v2/options.md
+++ b/docs/v2/options.md
@@ -11,8 +11,8 @@ each.
```js
linkify.options.defaults = {
attributes: null,
- className: 'linkified',
- defaultProtocol: 'http',
+ className: "linkified",
+ defaultProtocol: "http",
events: null,
format: function (value, type) {
return value;
@@ -22,11 +22,11 @@ linkify.options.defaults = {
},
ignoreTags: [],
nl2br: false,
- tagName: 'a',
+ tagName: "a",
target: {
- url: '_blank'
+ url: "_blank",
},
- validate: true
+ validate: true,
};
```
@@ -45,15 +45,15 @@ there.
```js
linkifyStr(str, options); // or `str.linkify(options)`
linkifyHtml(str, options);
-linkifyElement(document.getElementById('id'), options);
+linkifyElement(document.getElementById("id"), options);
$(selector).linkify(options);
-React.createElement(Linkify, {options: options}, str);
+React.createElement(Linkify, { options: options }, str);
```
## attributes
-* **Type**: `Object | Function (String href, String type)`
-* **Default**: `null`
+- **Type**: `Object | Function (String href, String type)`
+- **Default**: `null`
Object of attributes to add to each new link. **Note:** the [`class`](#classname)
and [`target`](#target) attributes have dedicated options.
@@ -62,18 +62,18 @@ Also accepts a function that takes the unformatted href, the link type (e.g.,
`'url'`, `'email'`, etc.) and returns the object.
```js
-'github.com'.linkify({
+"github.com".linkify({
attributes: {
- rel: 'nofollow'
- }
+ rel: "nofollow",
+ },
});
```
## className
-* **Type**: `String | Function (String href, String type) | Object`
-* **Default**: `'linkified'` (may be removed in future releases)
-* **Data API**: `data-linkify-class-name`
+- **Type**: `String | Function (String href, String type) | Object`
+- **Default**: `'linkified'` (may be removed in future releases)
+- **Data API**: `data-linkify-class-name`
`class` attribute to use for newly created links.
@@ -87,26 +87,26 @@ or function to use for that type.
in a future release.
```js
-'github.com'.linkify({
- className: 'new-link--url'
+"github.com".linkify({
+ className: "new-link--url",
});
// or
-'github.com'.linkify({
+"github.com".linkify({
className: function (href, type) {
- return 'new-link--' + type
- }
+ return "new-link--" + type;
+ },
});
// or
-'github.com'.linkify({
+"github.com".linkify({
className: {
- url: 'new-link--url',
+ url: "new-link--url",
email: function (href) {
- return 'new-link--email';
- }
- }
+ return "new-link--email";
+ },
+ },
});
```
@@ -118,10 +118,10 @@ Returns
## defaultProtocol
-* **Type**: `String`
-* **Default**: `'http'`
-* **Values**: `'http'`, `'https'`, `'ftp'`, `'ftps'`, etc.
-* **Data API**: `data-linkify-default-protocol`
+- **Type**: `String`
+- **Default**: `'http'`
+- **Values**: `'http'`, `'https'`, `'ftp'`, `'ftps'`, etc.
+- **Data API**: `data-linkify-default-protocol`
Protocol that should be used in `href` attributes for URLs without a protocol
(e.g., `github.com`).
@@ -130,8 +130,8 @@ Protocol that should be used in `href` attributes for URLs without a protocol
_\*element, jquery interfaces only\*_
-* **Type**: `Object | Function (String href, String type) | Object`
-* **Default**: `null`
+- **Type**: `Object | Function (String href, String type) | Object`
+- **Default**: `null`
Add event listeners to newly created link elements. Takes a hash where each key
is an [standard event](https://developer.mozilla.org/en-US/docs/Web/Events) name
@@ -141,15 +141,15 @@ Also accepts a function that takes the unformatted href and the link type (e.g.,
`'url'`, `'email'`, etc.) and returns the hash.
```js
-$('p').linkify({
+$("p").linkify({
events: {
click: function (e) {
- alert('Link clicked!');
+ alert("Link clicked!");
},
mouseover: function (e) {
- alert('Link hovered!');
- }
- }
+ alert("Link hovered!");
+ },
+ },
});
```
@@ -161,8 +161,8 @@ and the [linkify-react event docs](linkify-react.html#events)
## format
-* **Type**: `Function (String value, String type) | Object`
-* **Default**: `null`
+- **Type**: `Function (String value, String type) | Object`
+- **Default**: `null`
Format the text displayed by a linkified entity. e.g., truncate a long URL.
@@ -170,30 +170,34 @@ Accepts an object where each key is the link type (e.g., `'url'`, `'email'`,
etc.) and each value is the formatting function to use for that type.
```js
-'http://github.com/SoapBox/linkifyjs/search/?q=this+is+a+really+long+query+string'.linkify({
- format: function (value, type) {
- if (type === 'url' && value.length > 50) {
- value = value.slice(0, 50) + '…';
- }
- return value;
- }
-});
+"http://github.com/SoapBox/linkifyjs/search/?q=this+is+a+really+long+query+string".linkify(
+ {
+ format: function (value, type) {
+ if (type === "url" && value.length > 50) {
+ value = value.slice(0, 50) + "…";
+ }
+ return value;
+ },
+ },
+);
// or
-'http://github.com/SoapBox/linkifyjs/search/?q=this+is+a+really+long+query+string'.linkify({
- format: {
- url: function (value) {
- return value.length > 50 ? value.slice(0, 50) + '…' : value
- }
- }
-});
+"http://github.com/SoapBox/linkifyjs/search/?q=this+is+a+really+long+query+string".linkify(
+ {
+ format: {
+ url: function (value) {
+ return value.length > 50 ? value.slice(0, 50) + "…" : value;
+ },
+ },
+ },
+);
```
## formatHref
-* **Type**: `Function (String href, String type) | Object`
-* **Default**: `null`
+- **Type**: `Function (String href, String type) | Object`
+- **Default**: `null`
Similar to [format](#format), except the result of this function will be used as
the `href` attribute of the new link.
@@ -205,26 +209,29 @@ Accepts an object where each key is the link type (e.g., `'url'`, `'email'`,
etc.) and each value is the formatting function to use for that type.
```js
-'This site is #rad'.linkify({
+"This site is #rad".linkify({
formatHref: function (href, type) {
- if (type === 'hashtag') {
- href = 'https://twitter.com/hashtag/' + href.substring(1);
+ if (type === "hashtag") {
+ href = "https://bsky.app/hashtag/" + href.substring(1);
}
return href;
- }
+ },
});
// or
-'Hey @nfrasser, check out issue #23'.linkify({
+"Hey @nfrasser, check out issue #23".linkify({
formatHref: {
mention: function (href) {
- return 'https://github.com' + href;
+ return "https://github.com" + href;
},
ticket: function (href) {
- return 'https://github.com/{{ site.github_username }}/issues/' + href.substring(1);
- }
- }
+ return (
+ "https://github.com/{{ site.github_username }}/issues/" +
+ href.substring(1)
+ );
+ },
+ },
});
```
@@ -232,8 +239,8 @@ etc.) and each value is the formatting function to use for that type.
_\*element, html, and jquery interfaces only\*_
-* **Type**: `Array`
-* **Default**: `[]`
+- **Type**: `Array`
+- **Default**: `[]`
Prevent linkify from trying to parse links in the specified tags. This is useful
when running linkify on arbitrary HTML.
@@ -241,36 +248,40 @@ when running linkify on arbitrary HTML.
```js
linkifyHtml(
'Please ignore \n' +
- 'but do b.ca', {
- ignoreTags: [
- 'script',
- 'style'
- ]
-});
+ "but do b.ca",
+ {
+ ignoreTags: ["script", "style"],
+ },
+);
```
Returns
```html
-Please ignore
-but do b.ca
+Please ignore
+
+but do
+b.ca
```
Notice that there is no hyperlink at "a.com" inside the `script` tag.
## nl2br
-* **Type**: `Boolean`
-* **Default**: `false`
-* **Data API**: `data-linkify-nl2br`
+- **Type**: `Boolean`
+- **Default**: `false`
+- **Data API**: `data-linkify-nl2br`
If true, `\n` line breaks will automatically be converted to `
` tags.
## tagName
-* **Type**: `String | Function (String href, String type) | Object`
-* **Default**: `a`
-* **Data API**: `data-linkify-tagname`
+- **Type**: `String | Function (String href, String type) | Object`
+- **Default**: `a`
+- **Data API**: `data-linkify-tagname`
The tag name to use for each link. For cases where you can't use anchor tags.
@@ -281,16 +292,16 @@ Accepts an object where each key is the link type and each value is the tag name
to use for that type.
```js
-'github.com'.linkify({
- tagName: 'span'
+"github.com".linkify({
+ tagName: "span",
});
// or
-'#swag'.linkify({
+"#swag".linkify({
tagName: {
- hashtag: 'span'
- }
+ hashtag: "span",
+ },
});
```
@@ -302,9 +313,9 @@ Returns
## target
-* **Type**: `String | Function (String href, String type) | Object`
-* **Default**: `'_blank'` for URLs, `null` for everything else
-* **Data API**: `data-linkify-target`
+- **Type**: `String | Function (String href, String type) | Object`
+- **Default**: `'_blank'` for URLs, `null` for everything else
+- **Data API**: `data-linkify-target`
`target` attribute for generated link.
@@ -315,23 +326,23 @@ Accepts an object where each key is the link type and each value is the target
to use for that type.
```js
-'github.com'.linkify({
- target: '_parent'
+"github.com".linkify({
+ target: "_parent",
});
// or
-'test-email@example.com'.linkify({
+"test-email@example.com".linkify({
target: {
- url: '_parent',
- email: null
- }
+ url: "_parent",
+ email: null,
+ },
});
```
## validate
-* **Type**: `Boolean | Function (String value, String type) | Object`
-* **Default**: `null`
+- **Type**: `Boolean | Function (String value, String type) | Object`
+- **Default**: `null`
If option resolves to false, the given value will not show up as a link.
@@ -345,12 +356,12 @@ validation option to use for that type
```js
// Don't linkify links that don't begin in a protocol
// e.g., "http://google.com" will be linkified, but "google.com" will not.
-'www.google.com'.linkify({
+"www.google.com".linkify({
validate: {
url: function (value) {
return /^(http|ftp)s?:\/\//.test(value);
- }
- }
+ },
+ },
});
```
diff --git a/index.html b/index.html
index cc859b27..c2944e02 100644
--- a/index.html
+++ b/index.html
@@ -1,22 +1,48 @@
---
layout: default
headeroffset: y
-showbyhypercontext: true
+showsubtitle: true
scripts:
- home.js
- demo.js
---
+
{% include linkify-logo.svg %}
- Download Zip
+
+ Download Zip
+
- Read the Docs
+
+ Read the Docs
+
+
+
+ Install with NPM:
+ npm install linkifyjs
+
+
+
+ 
+
+ ·
+
+ view release notes
+
+ ·
+
+ browse code on GitHub
+
- Install with NPM: npm install linkifyjs
- v{{ site.version }} · view release notes · browse code on GitHub
@@ -26,15 +52,22 @@
Demo
- Enter some links into the "Before" box below. The result will appear in the "After" box in real-time.
+
+ Enter some links into the "Before" box below. The result will appear in
+ the "After" box in real-time.
+
Before
After
-
+Linkify is made with ❤️ by @nfrasser
+
-
+
@@ -74,10 +111,9 @@ Features
Learn how to use Linkify in your project
-
-
-
-
- What is Hypercontext?
- Linkify is maintained by @nfrasser and @Hypercontext. Hypercontext helps managers have better 1:1s and team meetings.
Build agendas, manage meetings, set goals, and get feedback—all in one place. Learn more at hypercontext.com
+
diff --git a/js/demo.coffee b/js/demo.coffee
index a6d9479f..fcb97555 100644
--- a/js/demo.coffee
+++ b/js/demo.coffee
@@ -7,7 +7,7 @@ options =
rel: 'nofollow noreferrer noopener'
formatHref:
hashtag: (val) ->
- "https://www.twitter.com/hashtag/#{val.substr(1)}"
+ "https://bsky.app/hashtag/#{val.substr(1)}"
mention: (val) ->
"https://github.com/#{val.substr(1)}"
- Download Zip + + Download Zip + - Read the Docs + + Read the Docs + +
+
+ Install with NPM:
+ npm install linkifyjs
+
+
+
+
+ ·
+
+ view release notes
+
+ ·
+
+ browse code on GitHub
+
Install with NPM: npm install linkifyjs
v{{ site.version }} · view release notes · browse code on GitHub
Demo
-Enter some links into the "Before" box below. The result will appear in the "After" box in real-time.
++ Enter some links into the "Before" box below. The result will appear in + the "After" box in real-time. +
Before
After
-
+Linkify is made with ❤️ by @nfrasser
+
-
+
@@ -74,10 +111,9 @@
-
-
-
diff --git a/js/demo.coffee b/js/demo.coffee
index a6d9479f..fcb97555 100644
--- a/js/demo.coffee
+++ b/js/demo.coffee
@@ -7,7 +7,7 @@ options =
rel: 'nofollow noreferrer noopener'
formatHref:
hashtag: (val) ->
- "https://www.twitter.com/hashtag/#{val.substr(1)}"
+ "https://bsky.app/hashtag/#{val.substr(1)}"
mention: (val) ->
"https://github.com/#{val.substr(1)}"
Features
Learn how to use Linkify in your project
- -What is Hypercontext?
-Linkify is maintained by @nfrasser and @Hypercontext. Hypercontext helps managers have better 1:1s and team meetings.
Build agendas, manage meetings, set goals, and get feedback—all in one place. Learn more at hypercontext.com