@domternal/extension-code-block-lowlight 0.2.0 → 0.3.0

package/README.md

@@ -1,53 +1,39 @@
 # @domternal/extension-code-block-lowlight
 
-Syntax-highlighted code blocks for the Domternal editor, powered by [lowlight](https://github.com/wooorm/lowlight) (highlight.js).
+[![Version](https://img.shields.io/npm/v/@domternal/extension-code-block-lowlight.svg)](https://www.npmjs.com/package/@domternal/extension-code-block-lowlight)
+[![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 <u>[ProseMirror](https://prosemirror.net/)</u>. 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
+## Links
 
-```bash
-npm install @domternal/core @domternal/extension-code-block-lowlight lowlight
-```
+<u>[Website](https://domternal.dev)</u> &nbsp;&nbsp;&nbsp;•&nbsp;&nbsp;&nbsp; <u>[Documentation](https://domternal.dev/v1/introduction)</u> &nbsp;&nbsp;&nbsp;•&nbsp;&nbsp;&nbsp; <u>[StackBlitz (Vanilla TS)](https://stackblitz.com/edit/domternal-vanilla-full-example)</u> &nbsp;&nbsp;&nbsp;•&nbsp;&nbsp;&nbsp; <u>[StackBlitz (Angular)](https://stackblitz.com/edit/domternal-angular-full-example)</u>
 
-## Usage
+## Features
 
-```ts
-import { Editor, StarterKit } from '@domternal/core';
-import { CodeBlockLowlight } from '@domternal/extension-code-block-lowlight';
-import { createLowlight, common } from 'lowlight';
+See <u>[Packages & Bundle Size](https://domternal.dev/v1/packages)</u> for a full breakdown of all packages and what each one includes.
 
-const lowlight = createLowlight(common);
+- **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), <u>[~108 KB total](https://domternal.dev/v1/packages)</u> with ProseMirror
+- **TypeScript first** - 100% typed, zero `any`
+- **4,400+ tests** - 2,687 unit tests and 1,796 E2E tests across 37 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.configure({ codeBlock: false }), // disable the default CodeBlock
-    CodeBlockLowlight.configure({ lowlight }),
-  ],
-});
-```
+## Documentation
 
-### Options
-
-| Option | Default | Description |
-|---|---|---|
-| `lowlight` | (required) | A lowlight instance created with `createLowlight()` |
-| `defaultLanguage` | `null` | Default language when none is specified |
-| `autoDetect` | `true` | Auto-detect language when none is specified |
-| `tabIndentation` | `true` | Tab key inserts spaces inside code blocks |
-| `tabSize` | `2` | Number of spaces per tab |
-
-### Server-Side Rendering
-
-Use `generateHighlightedHTML` to produce syntax-highlighted HTML on the server:
-
-```ts
-import { generateHighlightedHTML } from '@domternal/extension-code-block-lowlight';
-
-const html = generateHighlightedHTML(jsonContent, { lowlight });
-```
+- <u>[Getting Started](https://domternal.dev/v1/getting-started)</u> - install and create your first editor
+- <u>[Introduction](https://domternal.dev/v1/introduction)</u> - core concepts, architecture, and design decisions
+- <u>[Packages & Bundle Size](https://domternal.dev/v1/packages)</u> - what each package includes and bundle size breakdown
+- <u>[Blog](https://domternal.dev/blog)</u>
 
 ## License
 
-[MIT](https://github.com/domternal/domternal/blob/main/LICENSE)
+<u>[MIT](https://github.com/domternal/domternal/blob/main/LICENSE)</u>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@domternal/extension-code-block-lowlight",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Code block with syntax highlighting via lowlight 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"
-  },
   "dependencies": {
     "hast-util-to-html": "^9.0.0"
   },
@@ -61,5 +51,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"
+  }
+}