pantoken / renderers/react-markdown/src / parseAlertMarker

Function: parseAlertMarker()

parseAlertMarker(text): { marker: AlertMarker; rest: string; } | undefined

Beta

Detect a GitHub alert marker at the start of text; returns the marker and the remaining text.

Parameters

text

string

Returns

{ marker: AlertMarker; rest: string; } | undefined

Example

import { parseAlertMarker } from "@pantoken/react-markdown";

parseAlertMarker("[!TIP] Helpful"); // { marker: "TIP", rest: "Helpful" }
parseAlertMarker("Plain text"); // undefined