pantoken / renderers/react-markdown/src / InstuiMarkdown

Function: InstuiMarkdown()

InstuiMarkdown(props): ReactNode

Beta

Render Markdown with Instructure UI element mappings and pantoken icon/color tokens.

Parameters

props

InstuiMarkdownProps

InstuiMarkdownProps.

Returns

ReactNode

Examples

Basic

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

<InstuiMarkdown>{"Go :arrow-left: back. Brand is #03893D.\n\n> [!TIP]\n> Helpful."}</InstuiMarkdown>;

With brand icons via a plugin

import { InstuiMarkdown } from "@pantoken/react-markdown";
import { simpleIcons } from "@pantoken/plugin-simple-icons";
import * as registry from "simple-icons";

<InstuiMarkdown renderOptions={{ icons: { plugins: [simpleIcons({ registry })] } }}>
  {"Star us on :github:"}
</InstuiMarkdown>;