@fedify/markdown-it-mention@0.3.0
Built and signed on GitHub Actions
Built and signed on GitHub Actions

latest

A markdown-it plugin that parses and renders Mastodon-style @mentions

Published

8 months ago (0.3.0)

interface PluginOptions

Options for the plugin.

Properties

optional



localDomain: (bareHandle: string,
env: any,
) => string | null

A function to determine the domain of a bare handle. If it returns null, the bare handle will be rendered as plain text. null by default.

optional



link: (handle: string,
env: any,
) => string | null

A function to render a link href for a mention. If it returns null, the mention will be rendered as plain text. acct:${handle} by default.

optional



linkAttributes: (handle: string,
env: any,
) => Record<string, string>

A function to render extra attributes for a mention link.

optional



label: (handle: string,
env: any,
) => string

A function to render a label for a mention link. toBareHandle by default.

Add Package

deno add jsr:@fedify/markdown-it-mention

Import symbol

import { type PluginOptions } from "@fedify/markdown-it-mention";

Import directly with a jsr specifier

import { type PluginOptions } from "jsr:@fedify/markdown-it-mention";

Add Package

pnpm i jsr:@fedify/markdown-it-mention

or (using pnpm 10.8 or older)

pnpm dlx jsr add @fedify/markdown-it-mention

Import symbol

import { type PluginOptions } from "@fedify/markdown-it-mention";

Add Package

yarn add jsr:@fedify/markdown-it-mention

or (using Yarn 4.8 or older)

yarn dlx jsr add @fedify/markdown-it-mention

Import symbol

import { type PluginOptions } from "@fedify/markdown-it-mention";

Add Package

vlt install jsr:@fedify/markdown-it-mention

Import symbol

import { type PluginOptions } from "@fedify/markdown-it-mention";

Add Package

npx jsr add @fedify/markdown-it-mention

Import symbol

import { type PluginOptions } from "@fedify/markdown-it-mention";

Add Package

bunx jsr add @fedify/markdown-it-mention

Import symbol

import { type PluginOptions } from "@fedify/markdown-it-mention";