https://github.com/rotorz/markdown-it-external-links
Plugin for markdown-it that adds CSS classes to links that fall outside of the specified internal domain(s).
https://github.com/rotorz/markdown-it-external-links
Last synced: about 2 months ago
JSON representation
Plugin for markdown-it that adds CSS classes to links that fall outside of the specified internal domain(s).
- Host: GitHub
- URL: https://github.com/rotorz/markdown-it-external-links
- Owner: rotorz
- License: mit
- Created: 2016-07-08T22:09:12.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-11-06T19:33:09.000Z (over 5 years ago)
- Last Synced: 2025-03-27T08:11:18.210Z (2 months ago)
- Language: JavaScript
- Size: 12.7 KB
- Stars: 13
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# markdown-it-external-links [](https://travis-ci.org/rotorz/markdown-it-external-links)
[](https://badge.fury.io/js/markdown-it-external-links)
[](https://david-dm.org/rotorz/markdown-it-external-links)
[](https://david-dm.org/rotorz/markdown-it-external-links#info=devDependencies)
Plugin for markdown-it that adds CSS classes to links that fall outside of the specified
internal domain(s).
Example input:
```markdown
- [Internal Link A](/)
- [Internal Link B](//example.org)
- [Internal Link C](http://example.org)
- [Internal Link D](other-page.html)
- [Internal Link E](.././other-page.html)
- [External Link A](//example.com)
- [External Link B](http://example.com)
```
Output (without internal link class - default):
```html
- Internal Link A
- Internal Link B
- Internal Link C
- Internal Link D
- Internal Link E
- External Link A
- External Link B
```
Output (with internal link class):
```html
- Internal Link A
- Internal Link B
- Internal Link C
- Internal Link D
- Internal Link E
- External Link A
- External Link B
```
## Install
```
$ npm install --save markdown-it-external-links
```
## Usage
```javascript
var md = require('markdown-it')();
var externalLinks = require('markdown-it-external-links');
md.use(externalLinks, {
externalClassName: "custom-external-link",
internalClassName: "custom-internal-link",
internalDomains: [ "example.org" ]
});
var input = '[Some External Link](http://example.com)';
var output = md.render(input);
console.log(output);
```
### Options
Option | Type | Default | Description
:-------------------|:-------------------|:---------------------|:----------------------------------------------------------------------------------------
`externalClassName` | `string` \| `null` | `"external-link"` | External class to use for external links. Specify a value of `null` to disable output.
`internalClassName` | `string` \| `null` | `null` | Internal class to use for external links. Specify a value of `null` to disable output.
`internalDomains` | `string[]` | `[]` | An array of domains that are considered internal. **Example Value:** `[ "example.org" ]`
`externalTarget` | `string` | `"_self"` | Target attribute for external links.
`internalTarget` | `string` | `"_self"` | Target attribute for internal links.
`externalRel` | `string` | `null` | Rel attribute for external links.
`internalRel` | `string` | `null` | Rel attribute for internal links.
## Contribution Agreement
This project is licensed under the MIT license (see LICENSE). To be in the best
position to enforce these licenses the copyright status of this project needs to
be as simple as possible. To achieve this the following terms and conditions
must be met:
- All contributed content (including but not limited to source code, text,
image, videos, bug reports, suggestions, ideas, etc.) must be the
contributors own work.
- The contributor disclaims all copyright and accepts that their contributed
content will be released to the public domain.
- The act of submitting a contribution indicates that the contributor agrees
with this agreement. This includes (but is not limited to) pull requests, issues,
tickets, e-mails, newsgroups, blogs, forums, etc.