Skip to content

pantoken / renderers/react-markdown/src / InstuiMarkdown

Функция: InstuiMarkdown()

InstuiMarkdown(props): ReactNode

Бета

Рендерить Markdown с отображением элементов Instructure UI и токенов иконок/цветов pantoken.

Параметры

props

InstuiMarkdownProps

InstuiMarkdownProps.

Возвращаемое значение

ReactNode

Примеры

Basic

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

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

С фирменными иконками через плагин

tsx
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>;