markdown-it-mentions v1.0.0

markdown-it-mentions

markdown-it plugin to support Twitter like mentions

Usage

Download it with

yarn add markdown-it-mentions
# npm i markdown-it-mentions

Then use it as any markdown-it plugin

import md from 'markdown-it';
import mentions from 'markdown-it-mentions';

const markdown = '@sergiodxa';

// optional
function parseURL(username) {
  return `https://twitter.com/@${username}``
}

md()
  .use(mentions, { parseURL, external: true })
  .render(markdown)

This will transform every string starting with @ to a link to Twitter using the text after the @ as the username.

The optional parseURL function allow you to customize the final URL to use another site like Github or a completely personal one.

The optional external property (default to false) add a target="_blank" attribute if it's true and target="_self" if it's false.