gzkx-editor 0.0.0 → 0.0.1

package/core/README.md

@@ -0,0 +1,124 @@
+# @gzkx-editor/core
+
+GZKX Editor — all ProseMirror modules bundled into a single package.
+
+## Installation
+
+```bash
+npm install @gzkx-editor/core
+```
+
+Requires `orderedmap` as a peer dependency:
+
+```bash
+npm install orderedmap
+```
+
+## Quick Start
+
+```js
+import { EditorState } from '@gzkx-editor/core';
+import { EditorView } from '@gzkx-editor/core';
+import { Schema, DOMParser } from '@gzkx-editor/core';
+import { exampleSetup } from '@gzkx-editor/core';
+```
+
+## Usage
+
+### Creating an Editor
+
+```js
+import { EditorState } from '@gzkx-editor/core';
+import { EditorView } from '@gzkx-editor/core';
+import { schemaBasic } from '@gzkx-editor/core';
+import { exampleSetupProvider } from '@gzkx-editor/core';
+
+const state = EditorState.create({
+  doc: DOMParser.fromSchema(schemaBasic).parse('<p>Hello world</p>'),
+  plugins: exampleSetupProvider({ schema: schemaBasic })
+});
+
+const view = new EditorView(document.body, { state });
+```
+
+### Schema
+
+```js
+import { Schema } from '@gzkx-editor/core';
+
+// Define a custom schema
+const mySchema = new Schema({
+  nodes: {
+    doc: { content: 'block+' },
+    paragraph: { group: 'block', content: 'inline*' },
+    text: { group: 'inline' },
+  },
+  marks: {
+    strong: {},
+    em: {},
+  }
+});
+```
+
+### Editor State & Transactions
+
+```js
+import { EditorState } from '@gzkx-editor/core';
+import { Selection, TextSelection } from '@gzkx-editor/core';
+import { Transaction } from '@gzkx-editor/core';
+
+// Create state
+const state = EditorState.create({ schema });
+
+// Dispatch a transaction
+view.dispatch(state.tr.insertText('Hello'));
+```
+
+### Commands
+
+```js
+import { deleteSelection, joinBackward, wrapIn } from '@gzkx-editor/core';
+
+// Run a command
+if (deleteSelection(state, dispatch)) {
+  // ...
+}
+```
+
+### Key Modules
+
+This package includes all the following modules:
+
+| Module | Exports |
+|--------|---------|
+| **model** | `Node`, `Fragment`, `Slice`, `Mark`, `Schema`, `DOMParser`, `DOMSerializer` |
+| **transform** | `Step`, `Transform`, `ReplaceStep`, `AddMarkStep`, `ReplaceAroundStep` |
+| **state** | `EditorState`, `Transaction`, `Selection`, `Plugin` |
+| **view** | `EditorView`, `Decoration`, `DecorationSet` |
+| **commands** | `deleteSelection`, `joinBackward`, `wrapIn`, `setBlockType`, `toggleMark` |
+| **keymap** | `keymap`, `baseKeymap` |
+| **inputrules** | `inputRules`, `smartQuotes`, `wrappingInputRule` |
+| **history** | `history`, `undo`, `redo`, `historyKeymap` |
+| **dropcursor** | `dropCursor` |
+| **gapcursor** | `gapCursor` |
+| **schema-basic** | `schemaBasic`, `listSchema` |
+| **schema-list** | `orderedList`, `bulletList`, `listItem` |
+| **menu** | `menuBar`, `dropdown`, `menuItem`, `icons` |
+| **collab** | `collab`, `sendable`, `receive` |
+| **example-setup** | `exampleSetup`, `buildMenuItems`, `buildKeymap`, `buildInputRules` |
+| **markdown** | `parser`, `serializer`, `toMarkdown` |
+| **search** | `searchKeymap`, `findDialog` |
+| **changeset** | `Change`, `ChangeSet` |
+| **test-builder** | `builder`, `doc`, `paragraph`, `text`, `blockquote` |
+
+## TypeScript
+
+This package ships TypeScript declarations for all exports.
+
+```ts
+import { Node, Schema, EditorState } from '@gzkx-editor/core';
+```
+
+## License
+
+MIT

package/core/package.json

@@ -13,7 +13,8 @@
   "sideEffects": false,
   "license": "MIT",
   "files": [
-    "dist/"
+    "dist/",
+    "README.md"
   ],
   "dependencies": {
     "orderedmap": "^2.0.0"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gzkx-editor",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Structured WYSIWYM editor",
   "license": "MIT",
   "maintainers": [
@@ -27,7 +27,6 @@
   "workspaces": [
     "*"
   ],
-  
   "devDependencies": {
     "@rollup/plugin-typescript": "^12.3.0",
     "esbuild": "^0.28.0",