@fedify/markdown-it-mention

This is a markdown-it plugin that parses and renders Mastodon-style @mentions, e.g., @[e-mail]. It converts them to a link, e.g.:

<a href="acct:@[e-mail]"><span class="at">@</span><span
  class="user">username</span></a>

The value of href attributes, other attributes (if any), and the content of the link can be customized by passing options to the plugin:

import MarkdownIt from "markdown-it";
import { mention, toFullHandle } from "@fedify/markdown-it-mention";

const md = new MarkdownIt();
md.use(mention, {
  link: (handle: string) => `https://example.com/${handle}`,
  linkAttributes: (handle: string) => ({ class: "mention" }),
  label: toFullHandle,
});

[!TIP] The link callback can return null to disable the link.

If you want to collect all the handles mentioned in the document, you can pass the environment object to the render() method:

const env = {};
md.render(
  "# Hello, @[e-mail]\n\n> @[e-mail]",
  env,
);
console.log(env.mentions);  // ["@[e-mail]", "@[e-mail]"]

Installation

Deno

deno add @fedify/markdown-it-mention

Node.js

npm add @fedify/markdown-it-mention

Bun

bun add @fedify/markdown-it-mention