You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contributing
2
2
3
-
**Note:** This guide is a work in progress. Feel free to [submit an issue](https://github.com/Hypercontext/linkifyjs/issues/new) if anything is confusing or unclear.
3
+
**Note:** This guide is a work in progress. Feel free to [submit an issue](https://github.com/nfrasser/linkifyjs/issues/new) if anything is confusing or unclear.
4
4
5
5
## How linkify works
6
6
@@ -14,19 +14,19 @@ The second stage, the parser, takes this array of tokens and aggregates them int
14
14
15
15
A multitoken is either a link or not a link. Core linkify comes with these multitokens
16
16
17
-
***`Text`** is plain text (that contains no linkable entities)
18
-
***`Nl`** represents a single newline character
19
-
***`Email`** email address
20
-
***`URL`**
17
+
-**`Text`** is plain text (that contains no linkable entities)
18
+
-**`Nl`** represents a single newline character
19
+
-**`Email`** email address
20
+
-**`URL`**
21
21
22
22
The latter two are converted to links. `Nl` is in some cases converted to a `<br>` HTML tag.
23
23
24
24
You can use the Token class system to [create plugins](#building-plugins).
25
25
26
26
## Style
27
27
28
-
* ES6 Syntax (except tests for now)
29
-
* Hard tabs with a width of 4 characters
28
+
- ES6 Syntax (except tests for now)
29
+
- Hard tabs with a width of 4 characters
30
30
31
31
Keep your changes consistent with what's already there.
32
32
@@ -56,22 +56,22 @@ This transpiles ES6 to ES5 (via [Babel](http://babeljs.io/)) from `src/` into `d
56
56
57
57
These tools are used for testing linkify:
58
58
59
-
*[Mocha](https://mochajs.org/) is our primary test case framework
60
-
*[ESLint](https://eslint.org) for code linting
61
-
*[Istanbul](https://istanbul.js.org/) for code coverage analysis
62
-
*[Karma](http://karma-runner.github.io/) is our browser test runner
63
-
*[BrowserStack](https://www.browserstack.com) for cross-browser testing
59
+
-[Mocha](https://mochajs.org/) is our primary test case framework
60
+
-[ESLint](https://eslint.org) for code linting
61
+
-[Istanbul](https://istanbul.js.org/) for code coverage analysis
62
+
-[Karma](http://karma-runner.github.io/) is our browser test runner
63
+
-[BrowserStack](https://www.browserstack.com) for cross-browser testing
64
64
65
65
These are all configured to run in npm scripts. Tasks `npm test` and `npm run lint` are the most basic you can run. Other tasks include:
66
66
67
-
*`npm run build` converts the `src` ES source code into browser- and Node.js- compatible JavaScript. It also outputs TypeScript definitions.
68
-
*`npm run clean` removes all generated files
69
-
*`npm run dist` cleans, builds and copies the final browser distribution bundle into the root `dist` directory
67
+
-`npm run build` converts the `src` ES source code into browser- and Node.js- compatible JavaScript. It also outputs TypeScript definitions.
68
+
-`npm run clean` removes all generated files
69
+
-`npm run dist` cleans, builds and copies the final browser distribution bundle into the root `dist` directory
70
70
71
71
### Building plugins
72
72
73
73
**Caution:** The plugin development API is in its very early stages and only supports very basic plugins. Updated features, APIs, and docs are in the works.
74
74
75
-
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.
75
+
Check out the sample [Hashtag plugin](https://github.com/nfrasser/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.
76
76
77
77
Register a new plugin with [`linkify.registerPlugin()`](https://linkify.js.org/docs/linkifyjs.html#linkifyregisterplugin-name-plugin).
Linkify is a JavaScript plugin. Use Linkify to find links in plain-text and
9
9
convert them to HTML <a> tags. It automatically highlights URLs,
@@ -40,7 +40,7 @@ convert them to HTML <a> tags. It automatically highlights URLs,
40
40
41
41
[View full documentation](https://linkify.js.org/docs/).
42
42
43
-
Download the [latest release](https://github.com/Hypercontext/linkifyjs/releases) for direct use in the browser, or install via [NPM](https://www.npmjs.com/):
43
+
Download the [latest release](https://github.com/nfrasser/linkifyjs/releases) for direct use in the browser, or install via [NPM](https://www.npmjs.com/):
44
44
45
45
```
46
46
npm install linkifyjs linkify-html
@@ -150,20 +150,20 @@ supported.
150
150
151
151
## Downloads
152
152
153
-
Download the [**latest release**](https://github.com/Hypercontext/linkifyjs/releases)
153
+
Download the [**latest release**](https://github.com/nfrasser/linkifyjs/releases)
154
154
155
155
## API Documentation
156
156
157
157
View full documentation at [linkify.js.org/docs](https://linkify.js.org/docs/)
158
158
159
159
## Contributing
160
160
161
-
Check out [CONTRIBUTING.md](https://github.com/Hypercontext/linkifyjs/blob/main/CONTRIBUTING.md).
161
+
Check out [CONTRIBUTING.md](https://github.com/nfrasser/linkifyjs/blob/main/CONTRIBUTING.md).
162
162
163
163
## License
164
164
165
165
MIT
166
166
167
167
## Authors
168
168
169
-
Linkify is made with ❤️ by [Hypercontext](https://hypercontext.com/) and [@nfrasser](https://github.com/nfrasser)
169
+
Linkify is made with ❤️ by [@nfrasser](https://github.com/nfrasser)
0 commit comments