Skip to content

pantoken / renderers/react-markdown/src / rehypeGithubAlerts

Funktion: rehypeGithubAlerts()

rehypeGithubAlerts(): (tree) => void

Beta

Ein rehype-Plugin, das GitHub-Alert-Blockzitate kennzeichnet: es erkennt einen [!NOTE]-artigen Marker am Anfang eines Blockzitats, speichert ihn als data-alert="note" und entfernt den Markierungstext. Die React blockquote-Komponente rendert dann eine InstUI Alert.

Rückgabe

(tree) => void

Beispiel

tsx
import Markdown from "react-markdown";
import { rehypeGithubAlerts } from "@pantoken/react-markdown";

<Markdown rehypePlugins={[rehypeGithubAlerts]}>{"> [!NOTE]\n> Heads up."}</Markdown>;