https://github.com/vitaliy-bobrov/remarkable-extlink

Adds `target` and `rel` attributes to external links.
https://github.com/vitaliy-bobrov/remarkable-extlink

markdown remarkable remarkable-plugin

Last synced: 16 days ago
JSON representation

Adds `target` and `rel` attributes to external links.

• Host: GitHub
• URL: https://github.com/vitaliy-bobrov/remarkable-extlink
• Owner: vitaliy-bobrov
• License: mit
• Created: 2017-01-21T21:11:56.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2020-06-07T15:10:15.000Z (over 4 years ago)
• Last Synced: 2024-10-24T00:13:15.656Z (20 days ago)
• Topics: markdown, remarkable, remarkable-plugin
• Language: JavaScript
• Homepage:
• Size: 13.7 KB
• Stars: 8
• Watchers: 1
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# remarkable-extlink 🔗

[![npm version](https://badge.fury.io/js/remarkable-extlink.svg)](https://badge.fury.io/js/remarkable-extlink)

[![npm](https://img.shields.io/npm/dt/remarkable-extlink.svg)](https://github.com/vitaliy-bobrov/remarkable-extlink)

[Remarkable](https://github.com/jonschlinkert/remarkable) plugin adds `target` and `rel` attributes for external links.

## Installation

- npm:

  `npm install --save-dev remarkable-extlink`

- yarn:

  `yarn add -D remarkable-extlink`

## Usage

```js

const Remarkable = require('remarkable');

const extLink = require('remarkable-extlink');

const md = new Remarkable();

md

  .use(extlink, {

    host: 'my-host.com'

  });

```

## Options

### host {String}

**Required**

You site host name to detect external links.

### target {String}

Target link attribute value, default `_blank`.

### rel {String}

Rel link attribute value, default `nofollow noreferrer noopener`.