prosekit 0.21.3 → 0.21.4

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.
Files changed (2) hide show
  1. package/README.md +35 -6
  2. package/package.json +20 -20
package/README.md CHANGED
@@ -1,13 +1,42 @@
1
1
  # prosekit
2
2
 
3
- This package provides a convenient way to install all the `@prosekit` scoped packages at once. This saves you from having to install each package individually.
3
+ [![npm](https://img.shields.io/npm/v/prosekit)](https://www.npmjs.com/package/prosekit)
4
4
 
5
- For example, the following two imports are equivalent:
5
+ The ultimate toolkit for building rich text editors on the web. Headless, type-safe, and composable, built on [ProseMirror](https://prosemirror.net/) with first-class support for [React](https://react.dev/), [Vue](https://vuejs.org/), [Preact](https://preactjs.com/), [Svelte](https://svelte.dev/), [Solid](https://www.solidjs.com/), and vanilla JavaScript.
6
6
 
7
- ```js
8
- import { defineItalic } from 'prosekit/extensions/italic'
7
+ ## Installation
8
+
9
+ ```bash
10
+ npm install prosekit
9
11
  ```
10
12
 
11
- ```js
12
- import { defineItalic } from '@prosekit/extension-italic'
13
+ ## Usage
14
+
15
+ ```ts
16
+ import { defineBasicExtension } from 'prosekit/basic'
17
+ import { createEditor } from 'prosekit/core'
18
+
19
+ const editor = createEditor({ extension: defineBasicExtension() })
13
20
  ```
21
+
22
+ Then mount the editor in your framework of choice. See the [Quick Start](https://prosekit.dev/getting-started/quick-start) for a complete example.
23
+
24
+ ## Documentation
25
+
26
+ For full documentation, visit [prosekit.dev](https://prosekit.dev).
27
+
28
+ ## Community
29
+
30
+ Join the community on [Discord](https://prosekit.dev/chat).
31
+
32
+ ## Changelog
33
+
34
+ Detailed changes for each release are documented in the [CHANGELOG.md](https://github.com/prosekit/prosekit/blob/master/packages/prosekit/CHANGELOG.md).
35
+
36
+ ## Sponsors
37
+
38
+ <p align="center"><a href="https://github.com/sponsors/ocavue"><img src="https://cdn.jsdelivr.net/gh/ocavue/sponsors/sponsorkit/sponsors.svg" alt="My Sponsors"></a></p>
39
+
40
+ ## License
41
+
42
+ [MIT](https://github.com/prosekit/prosekit/blob/master/LICENSE)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "prosekit",
3
3
  "type": "module",
4
- "version": "0.21.3",
4
+ "version": "0.21.4",
5
5
  "private": false,
6
6
  "description": "ProseKit: A toolkit for building rich text editors.",
7
7
  "author": {
@@ -586,17 +586,17 @@
586
586
  "src"
587
587
  ],
588
588
  "dependencies": {
589
- "@prosekit/basic": "0.9.4",
590
- "@prosekit/core": "0.12.2",
591
- "@prosekit/extensions": "0.17.3",
592
- "@prosekit/pm": "0.1.17",
593
- "@prosekit/lit": "0.6.6",
594
- "@prosekit/react": "0.7.5",
595
- "@prosekit/svelte": "0.9.5",
596
- "@prosekit/web": "0.8.5",
597
- "@prosekit/solid": "0.7.5",
598
- "@prosekit/vue": "0.7.5",
599
- "@prosekit/preact": "0.7.5"
589
+ "@prosekit/basic": "0.9.5",
590
+ "@prosekit/extensions": "0.17.4",
591
+ "@prosekit/core": "0.12.3",
592
+ "@prosekit/lit": "0.6.7",
593
+ "@prosekit/pm": "0.1.18",
594
+ "@prosekit/preact": "0.7.6",
595
+ "@prosekit/solid": "0.7.6",
596
+ "@prosekit/react": "0.7.6",
597
+ "@prosekit/vue": "0.7.6",
598
+ "@prosekit/web": "0.8.6",
599
+ "@prosekit/svelte": "0.9.6"
600
600
  },
601
601
  "peerDependencies": {
602
602
  "loro-crdt": ">= 1.10.0",
@@ -643,16 +643,16 @@
643
643
  }
644
644
  },
645
645
  "devDependencies": {
646
- "@types/react": "^19.2.14",
646
+ "@types/react": "^19.2.16",
647
647
  "@types/react-dom": "^19.2.3",
648
- "loro-crdt": "^1.12.1",
648
+ "loro-crdt": "^1.12.3",
649
649
  "loro-prosemirror": "^0.4.3",
650
650
  "preact": "^10.29.2",
651
- "react": "^19.2.6",
652
- "react-dom": "^19.2.6",
651
+ "react": "^19.2.7",
652
+ "react-dom": "^19.2.7",
653
653
  "solid-js": "^1.9.13",
654
- "svelte": "^5.55.7",
655
- "tsdown": "^0.22.0",
654
+ "svelte": "^5.56.1",
655
+ "tsdown": "^0.22.1",
656
656
  "typedoc": "^0.28.19",
657
657
  "typedoc-plugin-external-package-links": "^0.2.0",
658
658
  "typedoc-plugin-frontmatter": "^1.3.1",
@@ -660,9 +660,9 @@
660
660
  "typedoc-plugin-md": "^0.7.1",
661
661
  "typedoc-plugin-mdn-links": "^5.1.1",
662
662
  "typescript": "~6.0.3",
663
- "vue": "^3.5.34",
663
+ "vue": "^3.5.35",
664
664
  "y-prosemirror": "^1.3.7",
665
- "yjs": "^13.6.30",
665
+ "yjs": "^13.6.31",
666
666
  "@prosekit/config-tsdown": "0.0.0",
667
667
  "@prosekit/typedoc-plugin": "0.0.0"
668
668
  },