@jackuait/blok 0.2.0 → 0.3.1-beta.0
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 +27 -0
- package/dist/{blok-B0X1AdO9.mjs → blok-e-cML09O.mjs} +7784 -7656
- package/dist/blok.mjs +1 -1
- package/dist/blok.umd.js +29 -29
- package/dist/{index-BKqZbiWi.mjs → index-BeLqsXna.mjs} +3 -4
- package/package.json +10 -1
- package/types/api/styles.d.ts +0 -16
- package/types/configs/notifier.d.ts +0 -1
- package/types/index.d.ts +7 -0
- package/types/tools/header.d.ts +68 -0
- package/types/tools/index.d.ts +1 -0
package/README.md
CHANGED
|
@@ -34,6 +34,33 @@ or
|
|
|
34
34
|
yarn add @jackuait/blok
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
+
## Migrating from EditorJS
|
|
38
|
+
|
|
39
|
+
If you're migrating from EditorJS, Blok provides a seamless transition path:
|
|
40
|
+
|
|
41
|
+
### Automated Migration
|
|
42
|
+
|
|
43
|
+
Run the codemod to automatically update your codebase:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
# Preview changes (recommended first)
|
|
47
|
+
npx @jackuait/blok-codemod ./src --dry-run
|
|
48
|
+
|
|
49
|
+
# Apply changes
|
|
50
|
+
npx @jackuait/blok-codemod ./src
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
The codemod handles:
|
|
54
|
+
- Import updates (`@editorjs/editorjs` → `@jackuait/blok`)
|
|
55
|
+
- Type renames (`EditorConfig` → `BlokConfig`)
|
|
56
|
+
- CSS selector updates (`.ce-*` → `[data-blok-*]`)
|
|
57
|
+
- Data attribute updates (`data-id` → `data-blok-id`)
|
|
58
|
+
- Bundled tool migrations (Header & Paragraph are now included)
|
|
59
|
+
|
|
60
|
+
### Migration Guide
|
|
61
|
+
|
|
62
|
+
For a complete list of breaking changes and manual migration steps, see [MIGRATION.md](./MIGRATION.md).
|
|
63
|
+
|
|
37
64
|
## Documentation
|
|
38
65
|
|
|
39
66
|
📚 **Documentation is coming soon!** We're working hard to provide comprehensive guides, API references, and examples. Stay tuned for updates.
|