pantoken / renderers/react-markdown/src / parseAlertMarker

Funktion: parseAlertMarker() ​

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

Beta

Erkennt einen GitHub-Alarmmarker am Anfang des Textes; gibt den Marker und den verbleibenden Text zurück.

Parameter ​

text ​

string

Rückgabe ​

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

Beispiel ​

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

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