Skip to main content

Installation

npm install @aeven-ai/hypermarkdown

React 18 or 19 is required as a peer dependency.

Import the component stylesheet once in your application entry point:

import "@aeven-ai/hypermarkdown/styles.css";

Then import the component:

import {
HyperMarkdown,
type HyperMarkdownHandle,
} from "@aeven-ai/hypermarkdown";

Math, syntax highlighting, diagrams, and CJK-friendly emphasis are optional. Install only the extras you render; see Plugins.

KaTeX and highlight.js also need their own stylesheets when those plugins are enabled:

import "katex/dist/katex.min.css";
import "highlight.js/styles/github-dark.css";

Next: Finished Markdown or Streaming and delta rendering.