richtor 1.3.0 → 1.3.1
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 +6 -31
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,37 +17,12 @@ A beautiful and feature-rich WYSIWYG editor built with [Tiptap](https://tiptap.d
|
|
|
17
17
|
|
|
18
18
|
## Installation
|
|
19
19
|
|
|
20
|
-
### Quick Install (Recommended)
|
|
21
|
-
|
|
22
|
-
```bash
|
|
23
|
-
# Install richtor and all required TipTap dependencies
|
|
24
|
-
npm install richtor @tiptap/core @tiptap/react @tiptap/pm @tiptap/starter-kit \
|
|
25
|
-
@tiptap/extension-bubble-menu @tiptap/extension-bullet-list \
|
|
26
|
-
@tiptap/extension-character-count @tiptap/extension-code-block-lowlight \
|
|
27
|
-
@tiptap/extension-color @tiptap/extension-highlight \
|
|
28
|
-
@tiptap/extension-image @tiptap/extension-link \
|
|
29
|
-
@tiptap/extension-list-keymap @tiptap/extension-ordered-list \
|
|
30
|
-
@tiptap/extension-placeholder @tiptap/extension-subscript \
|
|
31
|
-
@tiptap/extension-superscript @tiptap/extension-table \
|
|
32
|
-
@tiptap/extension-table-cell @tiptap/extension-table-header \
|
|
33
|
-
@tiptap/extension-table-row @tiptap/extension-text-align \
|
|
34
|
-
@tiptap/extension-text-style @tiptap/extension-underline
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
### Why Install TipTap Separately?
|
|
38
|
-
|
|
39
|
-
Richtor requires TipTap as a peer dependency to avoid duplicate plugin instances. This ensures:
|
|
40
|
-
- ✅ No conflicts with your existing TipTap installation
|
|
41
|
-
- ✅ You control which TipTap version to use
|
|
42
|
-
- ✅ Smaller bundle size (no duplicates)
|
|
43
|
-
|
|
44
|
-
### Alternative: Use Installation Script
|
|
45
|
-
|
|
46
20
|
```bash
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
21
|
+
npm install richtor
|
|
22
|
+
# or
|
|
23
|
+
yarn add richtor
|
|
24
|
+
# or
|
|
25
|
+
pnpm add richtor
|
|
51
26
|
```
|
|
52
27
|
|
|
53
28
|
## Usage
|
|
@@ -152,4 +127,4 @@ Contributions are welcome! Please feel free to submit a Pull Request.
|
|
|
152
127
|
|
|
153
128
|
## Support
|
|
154
129
|
|
|
155
|
-
If you encounter any issues or have questions, please file an issue on the [GitHub repository](https://github.com/jamir-hossain/richtor/issues).
|
|
130
|
+
If you encounter any issues or have questions, please file an issue on the [GitHub repository](https://github.com/jamir-hossain/richtor/issues).
|
package/package.json
CHANGED