mdream 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -0
- package/dist/iife.js +1 -1
- package/package.json +15 -15
- package/wasm/mdream_edge_bg.wasm +0 -0
- package/wasm/package.json +1 -1
package/README.md
CHANGED
|
@@ -23,6 +23,29 @@ For the JavaScript-only engine (hook-based plugins, splitter, pure HTML parser):
|
|
|
23
23
|
pnpm add @mdream/js
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
+
### Bundler Compatibility
|
|
27
|
+
|
|
28
|
+
The `mdream` package uses native Node.js bindings (NAPI-RS) which cannot be statically bundled. If your bundler fails to resolve `mdream`, mark it as external:
|
|
29
|
+
|
|
30
|
+
**Next.js / Turbopack:**
|
|
31
|
+
```js
|
|
32
|
+
// next.config.js
|
|
33
|
+
const nextConfig = {
|
|
34
|
+
serverExternalPackages: ['mdream'],
|
|
35
|
+
}
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
**Webpack / other bundlers:**
|
|
39
|
+
```js
|
|
40
|
+
externals: ['mdream']
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
> [!TIP]
|
|
44
|
+
> [`@mdream/js`](https://github.com/harlan-zw/mdream/tree/main/packages/js) has zero native dependencies and works with all bundlers without configuration.
|
|
45
|
+
|
|
46
|
+
> [!TIP]
|
|
47
|
+
> Using Vite? [`@mdream/vite`](https://github.com/harlan-zw/mdream/tree/main/packages/vite) handles this automatically.
|
|
48
|
+
|
|
26
49
|
## Table of Contents
|
|
27
50
|
|
|
28
51
|
- [API Reference](#api-reference)
|