---
url: /api/renderers/react-markdown/src.md
---
[pantoken-root](../../../index.md) / react-markdown

# react-markdown

## Compatibility

Target: react-markdown. Current format: `SSR-rendered InstUI heading, icon, and color swatch with React 19.3.0`. Minimum host version: `10.1.0`. Tested through `10.1.0`. Newer releases require review.

[Full compatibility matrix](../../../../compatibility)

Beta

`@pantoken/react-markdown` — render Markdown with Instructure UI components and pantoken icons.

The default entry renders GitHub-Flavored Markdown, inline `:icon:` tokens (via
`@pantoken/rehype` + `@pantoken/icons`), color-code swatches, and GitHub-style alerts. The MDX
provider lives at `@pantoken/react-markdown/mdx`.

## Interfaces

* [InstuiMarkdownRenderOptions](interfaces/InstuiMarkdownRenderOptions.md)
* [InstuiMarkdownProps](interfaces/InstuiMarkdownProps.md)

## Type Aliases

* [AlertMarker](type-aliases/AlertMarker.md)

## Variables

* [instuiMarkdownComponents](variables/instuiMarkdownComponents.md)

## Functions

* [createInstuiMarkdownComponents](functions/createInstuiMarkdownComponents.md)
* [buildIconResolver](functions/buildIconResolver.md)
* [parseAlertMarker](functions/parseAlertMarker.md)
* [isColorValue](functions/isColorValue.md)
* [rehypeColorCodes](functions/rehypeColorCodes.md)
* [rehypeGithubAlerts](functions/rehypeGithubAlerts.md)
* [InstuiMarkdown](functions/InstuiMarkdown.md)