gen-streamdown 0.1.1 → 0.1.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 +49 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -26,8 +26,56 @@ This fork maintains all the features of the original [streamdown](https://github
|
|
|
26
26
|
|
|
27
27
|
## Installation
|
|
28
28
|
|
|
29
|
+
Install using your preferred package manager:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
# npm
|
|
33
|
+
npm install gen-streamdown
|
|
34
|
+
|
|
35
|
+
# pnpm
|
|
36
|
+
pnpm add gen-streamdown
|
|
37
|
+
|
|
38
|
+
# yarn
|
|
39
|
+
yarn add gen-streamdown
|
|
40
|
+
|
|
41
|
+
# bun
|
|
42
|
+
bun add gen-streamdown
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Peer Dependencies
|
|
46
|
+
|
|
47
|
+
Make sure you have React installed (required peer dependency):
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
# npm
|
|
51
|
+
npm install react
|
|
52
|
+
|
|
53
|
+
# pnpm
|
|
54
|
+
pnpm add react
|
|
55
|
+
|
|
56
|
+
# yarn
|
|
57
|
+
yarn add react
|
|
58
|
+
|
|
59
|
+
# bun
|
|
60
|
+
bun add react
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Optional Dependencies
|
|
64
|
+
|
|
65
|
+
For full functionality, you may also want to install optional plugins:
|
|
66
|
+
|
|
29
67
|
```bash
|
|
30
|
-
npm
|
|
68
|
+
# npm
|
|
69
|
+
npm install @streamdown/code @streamdown/math @streamdown/mermaid @streamdown/cjk
|
|
70
|
+
|
|
71
|
+
# pnpm
|
|
72
|
+
pnpm add @streamdown/code @streamdown/math @streamdown/mermaid @streamdown/cjk
|
|
73
|
+
|
|
74
|
+
# yarn
|
|
75
|
+
yarn add @streamdown/code @streamdown/math @streamdown/mermaid @streamdown/cjk
|
|
76
|
+
|
|
77
|
+
# bun
|
|
78
|
+
bun add @streamdown/code @streamdown/math @streamdown/mermaid @streamdown/cjk
|
|
31
79
|
```
|
|
32
80
|
|
|
33
81
|
Then, update your Tailwind `globals.css` to include the following so that Tailwind can detect the utility classes used by gen-streamdown.
|