You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: package/README.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,10 +31,10 @@ A performant client-side syntax highlighting component and hook for React, built
31
31
## Features
32
32
33
33
- 🖼️ Provides both a `ShikiHighlighter` component and a `useShikiHighlighter` hook for more flexibility
34
-
- 🔐 No `dangerouslySetInnerHTML` - output from Shiki is parsed using `html-react-parser`
34
+
- 🔐 Shiki output is processed from HAST directly into React elements, no `dangerouslySetInnerHTML` required
35
35
- 📦 Supports all built-in Shiki languages and themes
36
36
- 🖌️ Full support for custom TextMate themes and languages
37
-
- 🔧 Supports passing custom Shiki transformers to the highlighter
37
+
- 🔧 Supports passing custom Shiki transformers to the highlighter, in addition to all other options supported by `codeToHast`
38
38
- 🚰 Performant highlighting of streamed code, with optional throttling
39
39
- 📚 Includes minimal default styles for code blocks
40
40
- 🚀 Shiki dynamically imports only the languages and themes used on a page for optimal performance
@@ -80,6 +80,9 @@ function CodeBlock({ code, language }) {
80
80
81
81
### Common Configuration Options
82
82
83
+
> [!IMPORTANT]
84
+
> `react-shiki` now supports all options that [`codeToHast`](https://github.com/shikijs/shiki/blob/main/packages/types/src/options.ts#L121) supports, this table has not yet been updated to reflect this.
0 commit comments