richtor 1.0.10 → 1.0.11
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 +14 -2
- package/package.json +8 -2
package/README.md
CHANGED
|
@@ -17,6 +17,8 @@ A beautiful and feature-rich WYSIWYG editor built with [Tiptap](https://tiptap.d
|
|
|
17
17
|
|
|
18
18
|
## Installation
|
|
19
19
|
|
|
20
|
+
### 1. Install the package
|
|
21
|
+
|
|
20
22
|
```bash
|
|
21
23
|
npm install richtor
|
|
22
24
|
# or
|
|
@@ -25,12 +27,22 @@ yarn add richtor
|
|
|
25
27
|
pnpm add richtor
|
|
26
28
|
```
|
|
27
29
|
|
|
30
|
+
### 2. Install peer dependencies
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npm install @tiptap/core @tiptap/react @tiptap/pm @tiptap/starter-kit lucide-react lowlight highlight.js
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### 3. Import styles
|
|
37
|
+
|
|
38
|
+
```tsx
|
|
39
|
+
import 'richtor/style';
|
|
40
|
+
```
|
|
41
|
+
|
|
28
42
|
## Usage
|
|
29
43
|
|
|
30
44
|
### Basic Editor
|
|
31
45
|
|
|
32
|
-
**Styles are automatically included!** No need to manually import CSS.
|
|
33
|
-
|
|
34
46
|
```tsx
|
|
35
47
|
import { Editor } from 'richtor';
|
|
36
48
|
import { useState } from 'react';
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "richtor",
|
|
3
3
|
"private": false,
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.11",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"description": "A beautiful and feature-rich WYSIWYG editor built with Tiptap and shadcn/ui",
|
|
7
7
|
"author": "Jamir Hossain <jamir.hossain@example.com>",
|
|
@@ -27,13 +27,19 @@
|
|
|
27
27
|
"main": "./dist/editor.umd.js",
|
|
28
28
|
"module": "./dist/editor.es.js",
|
|
29
29
|
"types": "./dist/index.d.ts",
|
|
30
|
+
"sideEffects": [
|
|
31
|
+
"*.css",
|
|
32
|
+
"dist/richtor.css"
|
|
33
|
+
],
|
|
30
34
|
"exports": {
|
|
31
35
|
".": {
|
|
32
36
|
"import": "./dist/editor.es.js",
|
|
33
37
|
"require": "./dist/editor.umd.js",
|
|
34
38
|
"types": "./dist/index.d.ts"
|
|
35
39
|
},
|
|
36
|
-
"./
|
|
40
|
+
"./style": "./dist/richtor.css",
|
|
41
|
+
"./styles": "./dist/richtor.css",
|
|
42
|
+
"./dist/richtor.css": "./dist/richtor.css"
|
|
37
43
|
},
|
|
38
44
|
"files": [
|
|
39
45
|
"dist",
|