@domternal/pm 0.2.0 → 0.2.1

package/README.md

@@ -1,50 +1,35 @@
 # @domternal/pm
 
-Convenience re-exports of ProseMirror packages via subpath imports, so you can depend on a single package instead of twelve.
-
-Part of the [Domternal](https://github.com/domternal/domternal) toolkit. Full docs at [domternal.dev](https://domternal.dev).
-
-## Installation
-
-```bash
-npm install @domternal/pm
-```
-
-## Usage
-
-Import ProseMirror modules through subpath exports:
-
-```ts
-import { EditorState, Plugin, PluginKey } from '@domternal/pm/state';
-import { EditorView } from '@domternal/pm/view';
-import { Schema, Node, Mark } from '@domternal/pm/model';
-import { ReplaceStep } from '@domternal/pm/transform';
-import { keymap } from '@domternal/pm/keymap';
-import { undo, redo, history } from '@domternal/pm/history';
-import { baseKeymap } from '@domternal/pm/commands';
-import { inputRules } from '@domternal/pm/inputrules';
-import { dropCursor } from '@domternal/pm/dropcursor';
-import { gapCursor } from '@domternal/pm/gapcursor';
-import { tableEditing, columnResizing } from '@domternal/pm/tables';
-import { wrapInList, liftListItem } from '@domternal/pm/schema-list';
-```
-
-### Available Subpath Exports
-
-| Import | Re-exports |
-|---|---|
-| `@domternal/pm/state` | `prosemirror-state` |
-| `@domternal/pm/view` | `prosemirror-view` |
-| `@domternal/pm/model` | `prosemirror-model` |
-| `@domternal/pm/transform` | `prosemirror-transform` |
-| `@domternal/pm/commands` | `prosemirror-commands` |
-| `@domternal/pm/keymap` | `prosemirror-keymap` |
-| `@domternal/pm/history` | `prosemirror-history` |
-| `@domternal/pm/inputrules` | `prosemirror-inputrules` |
-| `@domternal/pm/dropcursor` | `prosemirror-dropcursor` |
-| `@domternal/pm/gapcursor` | `prosemirror-gapcursor` |
-| `@domternal/pm/tables` | `prosemirror-tables` |
-| `@domternal/pm/schema-list` | `prosemirror-schema-list` |
+[![Version](https://img.shields.io/npm/v/@domternal/pm.svg)](https://www.npmjs.com/package/@domternal/pm)
+[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/domternal/domternal/blob/main/LICENSE)
+
+A lightweight, extensible rich text editor toolkit built on [ProseMirror](https://prosemirror.net/). Framework-agnostic headless core with first-class **Angular** support. Use it headless with vanilla JS/TS, add the built-in toolbar and theme, or drop in ready-made Angular components. Fully tree-shakeable, import only what you use, unused extensions are stripped from your bundle.
+
+**[Website](https://domternal.dev)** · **[Documentation](https://domternal.dev/v1/introduction)** · **[StackBlitz (Vanilla TS)](https://stackblitz.com/edit/domternal-vanilla-full-example)** · **[StackBlitz (Angular)](https://stackblitz.com/edit/domternal-angular-full-example)**
+
+## Features
+
+See [Packages & Bundle Size](https://domternal.dev/v1/packages) for a full breakdown of all packages and what each one includes.
+
+- **Headless core** - use with any framework or vanilla JS/TS
+- **Angular components** - editor, toolbar, bubble menu, floating menu, emoji picker (signals, OnPush, zoneless-ready)
+- **57 extensions across 10 packages** - 23 nodes, 9 marks, and 25 behavior extensions
+- **140+ chainable commands** - `editor.chain().focus().toggleBold().run()`
+- **Full table support** - cell merging, column resize, row/column controls, cell toolbar, all free and MIT licensed
+- **Tree-shakeable** - import only what you use, your bundler strips the rest
+- **~38 KB gzipped** (own code), [~108 KB total](https://domternal.dev/v1/packages) with ProseMirror
+- **TypeScript first** - 100% typed, zero `any`
+- **4,200+ tests** - 2,675 unit tests and 1,550 E2E tests across 34 Playwright specs
+- **Light and dark theme** - 70+ CSS custom properties for full visual control
+- **Inline styles export** - `getHTML({ styled: true })` produces inline CSS ready for email clients, CMS, and Google Docs
+- **SSR helpers** - `generateHTML`, `generateJSON`, `generateText` for server-side rendering
+
+## Documentation
+
+- [Getting Started](https://domternal.dev/v1/getting-started) - install and create your first editor
+- [Introduction](https://domternal.dev/v1/introduction) - core concepts, architecture, and design decisions
+- [Packages & Bundle Size](https://domternal.dev/v1/packages) - what each package includes and bundle size breakdown
+- [Blog](https://domternal.dev/blog)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@domternal/pm",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "ProseMirror package re-exports for Domternal",
   "author": "https://github.com/ThomasNowHere",
   "license": "MIT",
@@ -130,18 +130,42 @@
   },
   "typesVersions": {
     "*": {
-      "commands": ["src/commands.d.ts"],
-      "dropcursor": ["src/dropcursor.d.ts"],
-      "gapcursor": ["src/gapcursor.d.ts"],
-      "history": ["src/history.d.ts"],
-      "inputrules": ["src/inputrules.d.ts"],
-      "keymap": ["src/keymap.d.ts"],
-      "model": ["src/model.d.ts"],
-      "schema-list": ["src/schema-list.d.ts"],
-      "state": ["src/state.d.ts"],
-      "tables": ["src/tables.d.ts"],
-      "transform": ["src/transform.d.ts"],
-      "view": ["src/view.d.ts"]
+      "commands": [
+        "src/commands.d.ts"
+      ],
+      "dropcursor": [
+        "src/dropcursor.d.ts"
+      ],
+      "gapcursor": [
+        "src/gapcursor.d.ts"
+      ],
+      "history": [
+        "src/history.d.ts"
+      ],
+      "inputrules": [
+        "src/inputrules.d.ts"
+      ],
+      "keymap": [
+        "src/keymap.d.ts"
+      ],
+      "model": [
+        "src/model.d.ts"
+      ],
+      "schema-list": [
+        "src/schema-list.d.ts"
+      ],
+      "state": [
+        "src/state.d.ts"
+      ],
+      "tables": [
+        "src/tables.d.ts"
+      ],
+      "transform": [
+        "src/transform.d.ts"
+      ],
+      "view": [
+        "src/view.d.ts"
+      ]
     }
   },
   "files": [
@@ -174,4 +198,4 @@
     "url": "https://github.com/domternal/domternal/issues"
   },
   "homepage": "https://domternal.dev"
-}
+}