@domternal/extension-details 0.2.0 → 0.2.1

package/README.md

@@ -1,53 +1,35 @@
 # @domternal/extension-details
 
-Collapsible details/accordion blocks for the Domternal editor, rendered as semantic `<details>`/`<summary>` HTML.
+[![Version](https://img.shields.io/npm/v/@domternal/extension-details.svg)](https://www.npmjs.com/package/@domternal/extension-details)
+[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/domternal/domternal/blob/main/LICENSE)
 
-Part of the [Domternal](https://github.com/domternal/domternal) toolkit. Full docs at [domternal.dev](https://domternal.dev).
+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.
 
-## Installation
+**[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)**
 
-```bash
-npm install @domternal/core @domternal/extension-details
-```
+## Features
 
-## Usage
+See [Packages & Bundle Size](https://domternal.dev/v1/packages) for a full breakdown of all packages and what each one includes.
 
-```ts
-import { Editor, StarterKit } from '@domternal/core';
-import { Details, DetailsSummary, DetailsContent } from '@domternal/extension-details';
+- **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
 
-const editor = new Editor({
-  element: document.getElementById('editor')!,
-  extensions: [StarterKit, Details, DetailsSummary, DetailsContent],
-  content: '<p>Hello world</p>',
-});
+## Documentation
 
-// Wrap selected content in a details block
-editor.commands.setDetails();
-
-// Toggle details on/off
-editor.commands.toggleDetails();
-
-// Open or close programmatically
-editor.commands.openDetails();
-editor.commands.closeDetails();
-```
-
-### Commands
-
-| Command | Description |
-|---|---|
-| `setDetails` | Wrap selected content in a details structure |
-| `unsetDetails` | Lift content out of details (preserves summary as paragraph) |
-| `toggleDetails` | Toggle between wrapped and unwrapped |
-| `openDetails` / `closeDetails` | Programmatic open/close control |
-| `setDetailsOpen(boolean)` | Set the open state explicitly |
-
-### Options
-
-| Option | Default | Description |
-|---|---|---|
-| `persist` | `false` | Persist the open/closed state in the document |
+- [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/extension-details",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Details/accordion extension for Domternal editor",
   "author": "https://github.com/ThomasNowHere",
   "license": "MIT",
@@ -27,16 +27,6 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsup --clean",
-    "dev": "tsup --watch",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "lint": "eslint src",
-    "typecheck": "tsc --noEmit",
-    "prepublishOnly": "node -e \"const p=JSON.parse(require('fs').readFileSync('package.json','utf8'));delete p.devDependencies;if(p.dependencies){for(const[k,v]of Object.entries(p.dependencies)){if(v==='workspace:*')p.dependencies[k]='>=0.2.0'}}require('fs').writeFileSync('package.json',JSON.stringify(p,null,2)+'\\n')\"",
-    "postpublish": "git checkout package.json"
-  },
   "peerDependencies": {
     "@domternal/core": ">=0.2.0",
     "@domternal/pm": ">=0.2.0"
@@ -56,5 +46,13 @@
   "bugs": {
     "url": "https://github.com/domternal/domternal/issues"
   },
-  "homepage": "https://domternal.dev"
-}
+  "homepage": "https://domternal.dev",
+  "scripts": {
+    "build": "tsup --clean",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src",
+    "typecheck": "tsc --noEmit"
+  }
+}