@fileverse-dev/ddoc 2.1.3-patch-32 → 2.1.3-patch-33
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 +18 -14
- package/dist/index.es.js +77 -77
- package/dist/style.css +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,31 +5,35 @@
|
|
|
5
5
|
<img width="4410" alt="github_banner_final@3x" src="https://github.com/user-attachments/assets/c6ee706d-979d-41b6-9f73-d29fbabb5152" />
|
|
6
6
|
|
|
7
7
|
|
|
8
|
-
This
|
|
9
|
-
|
|
10
|
-
|
|
8
|
+
This repository contains:
|
|
9
|
+
- `/package` – The core package code.
|
|
10
|
+
- Example & demo source code to showcase dDocs functionalities.
|
|
11
11
|
|
|
12
12
|
## Usage
|
|
13
13
|
|
|
14
14
|
### Prequisites
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
To use dDocs, ensure your project is set up with Tailwind CSS and have a Tailwind configuration file.
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
### Install & import
|
|
19
|
+
Add the following imports :
|
|
20
|
+
```javascript
|
|
21
|
+
import { DdocEditor } from '@fileverse-dev/ddoc'
|
|
22
|
+
import '@fileverse-dev/ddoc/styles' // in App.jsx/App.tsx
|
|
23
|
+
```
|
|
19
24
|
|
|
20
|
-
`import '@fileverse-dev/ddoc/styles'` in App.jsx/App.tsx
|
|
21
25
|
|
|
22
|
-
|
|
26
|
+
### Update Tailwind Config
|
|
27
|
+
In your tailwind config, add this line to content array :
|
|
23
28
|
|
|
24
29
|
`@fileverse-dev/ddoc/dist/index.es.js`
|
|
25
30
|
|
|
26
|
-
|
|
31
|
+
You should now be set to use dDocs!
|
|
27
32
|
|
|
28
|
-
### Props
|
|
29
33
|
|
|
30
|
-
#
|
|
34
|
+
# dDocProps Interface
|
|
31
35
|
|
|
32
|
-
The `DdocProps` interface is a TypeScript interface that defines the properties for a
|
|
36
|
+
The `DdocProps` interface is a TypeScript interface that defines the properties for a page-related component. It includes properties for handling preview mode, managing publishing data, and optionally storing metadata and content associated with the page.
|
|
33
37
|
|
|
34
38
|
## Properties
|
|
35
39
|
|
|
@@ -77,7 +81,7 @@ The `DdocProps` interface is a TypeScript interface that defines the properties
|
|
|
77
81
|
|
|
78
82
|
## Data Interface
|
|
79
83
|
|
|
80
|
-
The `Data` interface defines the structure of the data object
|
|
84
|
+
The `Data` interface defines the structure of the data object.
|
|
81
85
|
|
|
82
86
|
### Properties
|
|
83
87
|
|
|
@@ -90,9 +94,9 @@ The `Data` interface defines the structure of the data object
|
|
|
90
94
|
- `npm i`
|
|
91
95
|
- `npm run dev`
|
|
92
96
|
|
|
93
|
-
It will open up a vite server, that will have the Ddoc Editor
|
|
97
|
+
It will open up a vite server, that will have the Ddoc Editor.
|
|
94
98
|
|
|
95
|
-
⚠️ This repository is currently undergoing rapid development, with frequent updates and changes. We recommend not to use in production yet
|
|
99
|
+
⚠️ This repository is currently undergoing rapid development, with frequent updates and changes. We recommend not to use in production yet.
|
|
96
100
|
|
|
97
101
|
## Pro Extensions Setup
|
|
98
102
|
|