markdown-it-external-anchor/README.md

Mark external, absolute links with necessary attributes

# MarkdownIt External Anchor
[![npm bundle size](https://img.shields.io/bundlephobia/min/markdown-it-external-anchor)](https://npmjs.com/package/markdown-it-external-anchor)
[![CI Test](https://github.com/binyamin/markdown-it-external-anchor/workflows/Test/badge.svg)](https://github.com/binyamin/markdown-it-external-anchor/actions)

Mark external, absolute links with appropriate rel & target attributes
- Prevents XSS attacks & provides good UX
- Does not affect HTML within markdown

> **Note**: If you want anything, just open an issue or [contact me](https://binyam.in/contact).

## Install
```console
$ npm install --save markdown-it markdown-it-external-anchor
```

## Usage
```js
const md = require("markdown-it")();
md.use(require("markdown-it-external-anchor"), {
    domain: "example.net",
    class: "external"
});

md.render("[text](https://example.com)");
```

### Options
- **domain** (default: `null`) - A domain which is considered an internal link. (no "https://"). When provided, localhost is also added.
- **class** (default: `null`) - a class name, for CSS purposes

## License
[MIT](https://github.com/binyamin/markdown-it-external-anchor/blob/main/LICENSE) © [Binyamin Green](https://binyam.in)