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: README.md
+28-4Lines changed: 28 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,12 @@
2
2
3
3
# react-native-enriched-markdown
4
4
5
-
`react-native-enriched-markdown` is a powerful React Native library that renders Markdown content as native text and provides a rich text input with Markdown output. It supports iOS, Android, and macOS, and requires the New Architecture (Fabric).
5
+
`react-native-enriched-markdown` is a powerful React Native library that renders Markdown content as native text and provides a rich text input with Markdown output. It supports iOS, Android, macOS, and Web, and requires the New Architecture (Fabric) for native platforms.
6
6
7
7
### EnrichedMarkdownText
8
8
9
9
- ⚡ Fully native text rendering (no WebView)
10
+
- 🌐 Web support via [react-native-web](https://necolas.github.io/react-native-web/) + [md4c](https://github.com/mity/md4c) compiled to WebAssembly
10
11
- 🎯 High-performance Markdown parsing with [md4c](https://github.com/mity/md4c)
11
12
- 📐 CommonMark standard compliant
12
13
- 📊 GitHub Flavored Markdown (GFM)
@@ -56,21 +57,40 @@ We can help you build your next dream product –
- Requires [the React Native New Architecture (Fabric)](https://reactnative.dev/architecture/landing-page)
68
70
- Supported React Native releases: `0.81`, `0.82`, `0.83`, and `0.84`
69
71
- macOS support via [react-native-macos](https://github.com/microsoft/react-native-macos)`0.81+`
70
72
73
+
**Web**
74
+
- Requires [`react-native-web`](https://necolas.github.io/react-native-web/) and Metro (or another bundler with `.web.tsx` platform resolution)
75
+
- No New Architecture requirement — the web renderer runs entirely in JavaScript via WebAssembly
76
+
- Only `EnrichedMarkdownText` is supported on web (`EnrichedMarkdownInput` is native-only)
77
+
- LaTeX math requires the optional [`katex`](https://katex.org/) peer dependency
78
+
71
79
## Installation
72
80
73
-
### Bare React Native app
81
+
### Web
82
+
83
+
No steps beyond having `react-native-web` configured. For LaTeX math, install the optional peer dependency:
84
+
85
+
```sh
86
+
npm install katex
87
+
# or
88
+
yarn add katex
89
+
```
90
+
91
+
See [Web Support](docs/WEB.md) for full setup details, supported features, and prop behaviour.
92
+
93
+
### Bare React Native app (iOS / Android)
74
94
75
95
#### 1. Install the library
76
96
@@ -140,6 +160,10 @@ See [EnrichedMarkdownInput](docs/INPUT.md) for detailed documentation on usage e
140
160
141
161
See the [API Reference](docs/API_REFERENCE.md) for a detailed overview of all the props, methods, and events available.
142
162
163
+
## Web Support
164
+
165
+
See [Web Support](docs/WEB.md) for details on supported features, web-specific prop behaviour, and known limitations.
166
+
143
167
## macOS Support
144
168
145
169
`react-native-enriched-markdown` supports macOS via [react-native-macos](https://github.com/microsoft/react-native-macos). See [macOS Support](docs/MACOS.md) for details on macOS-specific features, known limitations, and the example app.
@@ -149,7 +173,7 @@ See the [API Reference](docs/API_REFERENCE.md) for a detailed overview of all th
149
173
We're actively working on expanding the capabilities of `react-native-enriched-markdown`. Here's what's on the roadmap:
0 commit comments