readme, license and release info

Author: iamdabe

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 David Walker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,61 @@
+# Blazer Markdown Editor
+A lightweight ProseMirror-based Markdown editor for Blazor (including MudBlazor) with slash commands, table editing, and JSInterop-friendly APIs.
+
+## Contents
+- **[Features](#features)**
+- **[Preview](#preview)**
+  - [Desktop](#desktop)
+  - [Mobile](#mobile)
+- **[Install](#install)**
+  - [Install Method 1](#install-method-1)
+- **[Third-Party](#third-party)**
+
+Additional docs:
+- [JSInterop Packaging](docs/jsinterop-packaging.md)
+- [How to Use](docs/how-to-use.md)
+
+## Features
+* Markdown-first authoring with ProseMirror document model and serializer
+* Blazor-focused JSInterop API: `create`, `setMarkdown`, `getMarkdown`, `focus`, `destroy`
+* Productive editing features: slash menu, table controls, link toolbar, and keyboard shortcuts
+
+## Preview
+### Desktop
+Use `samples/index.html` to preview editor behavior in desktop browsers.
+
+### Mobile
+Use device emulation (or a real device) with `samples/index.html` to validate responsive behavior and touch interactions.
+
+## Install
+### Install Method 1
+1. Install dependencies:
+   - `npm ci`
+2. Build distributable assets:
+   - `npm run build`
+3. Include generated assets from `wwwroot` in your Blazor app:
+   - `blazer-markdown-editor.css`
+   - `blazer-markdown-editor.js`
+   - `blazer-markdown-editor.min.js`
+4. Call the global API via JSInterop:
+   - `window.blazerMarkdownEditor.create(...)`
+   - `window.blazerMarkdownEditor.setMarkdown(...)`
+   - `window.blazerMarkdownEditor.getMarkdown(...)`
+   - `window.blazerMarkdownEditor.focus(...)`
+   - `window.blazerMarkdownEditor.destroy(...)`
+
+Versioning uses a calendar schema: `YYYY.MINOR.PATCH` (current: `2026.2.1`).
+
+## Third-Party
+* markdown-it 14.1.0
+* prosemirror-commands 1.6.2
+* prosemirror-dropcursor 1.8.1
+* prosemirror-gapcursor 1.3.2
+* prosemirror-history 1.4.1
+* prosemirror-inputrules 1.4.0
+* prosemirror-keymap 1.2.2
+* prosemirror-markdown 1.13.2
+* prosemirror-model 1.24.1
+* prosemirror-schema-list 1.5.1
+* prosemirror-state 1.4.3
+* prosemirror-tables 1.8.3
+* prosemirror-view 1.38.1

docs/how-to-use.md

@@ -0,0 +1,35 @@
+# How to Use Blazer Markdown Editor
+
+## Build
+```bash
+npm ci
+npm run build
+```
+
+## Include in Blazor / MudBlazor
+Add built assets to your host page or static web assets pipeline:
+
+```html
+<link rel="stylesheet" href="_content/<YourPackageOrProject>/blazer-markdown-editor.css" />
+<script src="_content/<YourPackageOrProject>/blazer-markdown-editor.js"></script>
+```
+
+## JSInterop API
+Use the global object:
+
+- `window.blazerMarkdownEditor.create(target, { markdown })` → `editorId`
+- `window.blazerMarkdownEditor.setMarkdown(editorId, markdown)`
+- `window.blazerMarkdownEditor.getMarkdown(editorId)`
+- `window.blazerMarkdownEditor.focus(editorId)`
+- `window.blazerMarkdownEditor.destroy(editorId)`
+
+## Typical lifecycle (Blazor)
+1. On first render, call `create` with the target element.
+2. Push external value changes with `setMarkdown`.
+3. Pull current editor state with `getMarkdown` when saving.
+4. Dispose with `destroy` in component cleanup.
+
+## Notes
+- Keep `wwwroot` outputs as release artifacts (`js`, `min.js`, `css`).
+- Keep dependency versions pinned for deterministic behavior.
+- Use the packaging guidance in [jsinterop-packaging.md](jsinterop-packaging.md).

docs/jsinterop-packaging.md

@@ -1,113 +1,55 @@
-# ProseMirror Markdown Editor: production packaging for MudBlazor JSInterop
-
-This prototype is a strong start. For production in a Blazor/MudBlazor app, the safest path is to **ship this as a small JavaScript package** (or static asset bundle) with explicit pinned dependencies, instead of loading many modules directly from CDN import maps.
-
-## Recommended packaging approach
-
-1. Create a small frontend package (for example `@your-org/blazer-markdown-editor`).
-2. Move editor setup code into a module that exports a tiny API:
-   - `createEditor(element, options)`
-   - `setMarkdown(instance, markdown)`
-   - `getMarkdown(instance)`
-   - `destroy(instance)`
-3. Bundle with `esbuild`, `vite`, or `rollup` into one or two static files.
-4. Copy the built artifacts into `wwwroot` and call through JSInterop.
-5. Keep ProseMirror package versions pinned and update intentionally.
-
-## Minimal dependency set used by this prototype
-
-From current code paths, the direct runtime dependencies are:
-
-- `prosemirror-model`
-- `prosemirror-transform`
-- `prosemirror-state`
-- `prosemirror-view`
-- `prosemirror-keymap`
-- `prosemirror-history`
-- `prosemirror-commands`
-- `prosemirror-schema-list`
-- `prosemirror-inputrules`
-- `prosemirror-dropcursor`
-- `prosemirror-gapcursor`
-- `prosemirror-markdown`
-- `prosemirror-tables`
-- `markdown-it`
-
-`prosemirror-example-setup` and `prosemirror-menu` are not required.
-
-## Gaps / holes to evaluate before production
-
-- **Sanitization / trust boundary**
-  - If Markdown can come from untrusted users, sanitize rendered HTML on display paths.
-  - Keep `html: false` for markdown-it when parsing input in the editor.
-- **Persistence model**
-  - Decide if your source of truth is Markdown only, PM JSON only, or dual-format.
-  - If dual-format, define reconciliation rules and tests.
-- **Schema migrations**
-  - If schema changes later, old stored content may need migration logic.
-- **Plugin ordering contracts**
-  - Current setup depends on plugin order (slash menu priority, keymaps).
-  - Lock this in tests to prevent regressions.
-- **Keyboard behavior consistency**
-  - Verify Windows/macOS/Linux keybindings in Blazor host pages.
-- **Table markdown round-trip**
-  - Ensure table alignment and edge cases survive parse -> edit -> serialize cycles.
-- **Clipboard behavior**
-  - Paste detection is heuristic; test mixed-content clipboard payloads.
-- **Error reporting**
-  - Add JS-level hooks for errors/events so .NET can log and react.
-- **Styling isolation**
-  - Consider scoping editor styles to avoid collisions with MudBlazor theme styles.
-
-## Suggested JSInterop contract
-
-A minimal contract that stays stable:
-
-- `window.blazerMarkdownEditor.create(element, options)` => returns `editorId`
-- `window.blazerMarkdownEditor.setMarkdown(editorId, markdown)`
-- `window.blazerMarkdownEditor.getMarkdown(editorId)` => `string`
-- `window.blazerMarkdownEditor.onChange(editorId, dotNetRef, methodName)`
-- `window.blazerMarkdownEditor.destroy(editorId)`
-
-This keeps lifecycle ownership clear and avoids leaking ProseMirror internals into C#.
+# Blazer Markdown Editor: JSInterop Packaging
 
-## Why the prototype import map was adjusted
+This repo is optimized for Blazor/MudBlazor usage by shipping static assets from `wwwroot`.
 
-For local prototyping, import maps are fine and this prototype keeps explicit pinned CDN imports for compatibility. In production, prefer your own package lock + local bundling over CDN-resolved dependency trees.
+## Packaging model
 
-## What this repo now ships
+1. Author source in `src/`.
+2. Build distributables with `npm run build`.
+3. Ship only `wwwroot` artifacts in releases:
+   - `wwwroot/blazer-markdown-editor.js`
+   - `wwwroot/blazer-markdown-editor.min.js`
+   - `wwwroot/blazer-markdown-editor.css`
 
-This repo now includes lockfile + local bundling support:
-
-- `package.json` + `package-lock.json` for pinned JS dependencies
-- `src/blazer-markdown-editor.js` as the package entry
-- `scripts/build.mjs` build script
-- distributable assets in `wwwroot/` (JS generated by build):
-  - `wwwroot/blazer-markdown-editor.js`
-  - `wwwroot/blazer-markdown-editor.css`
-
-### Build
+## Build
 
 ```bash
 npm ci
 npm run build
 ```
 
-### MudBlazor/Blazor usage
+Build output includes license headers automatically.
+
+## Versioning
 
-Include the generated static assets:
+This project uses calendar versioning:
+
+- Format: `YYYY.MINOR.PATCH`
+- Current: `2026.2.1`
+
+## Blazor / MudBlazor consumption
+
+Include static assets:
 
 ```html
 <link rel="stylesheet" href="_content/<YourPackageOrProject>/blazer-markdown-editor.css" />
 <script src="_content/<YourPackageOrProject>/blazer-markdown-editor.js"></script>
 ```
 
-Then use JSInterop against:
+JSInterop API:
 
 - `window.blazerMarkdownEditor.create(target, { markdown })`
 - `window.blazerMarkdownEditor.setMarkdown(editorId, markdown)`
 - `window.blazerMarkdownEditor.getMarkdown(editorId)`
 - `window.blazerMarkdownEditor.focus(editorId)`
 - `window.blazerMarkdownEditor.destroy(editorId)`
 
-If this repo is consumed as a dependency in your MudBlazor solution, point your static-web-assets path to the `wwwroot` output and call `npm ci && npm run build` in your package/CI step.
+## Release process (artifact-only)
+
+Create a GitHub release with only the `wwwroot` files for that version.
+
+Suggested release assets:
+
+- `wwwroot/blazer-markdown-editor.js`
+- `wwwroot/blazer-markdown-editor.min.js`
+- `wwwroot/blazer-markdown-editor.css`

package.json

@@ -1,6 +1,6 @@
 {
   "name": "blazer-markdown-editor",
-  "version": "0.1.0",
+  "version": "2026.2.1",
   "private": true,
   "type": "module",
   "scripts": {

scripts/build.mjs

@@ -1,7 +1,10 @@
-import { copyFileSync, mkdirSync } from "node:fs";
+import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
+
+const licenseHeader = `// Copyright (c) 2026 David Walker\n// Licensed under the MIT License.\n\n`;
 
 mkdirSync("wwwroot", { recursive: true });
-copyFileSync("src/blazer-markdown-editor.css", "wwwroot/blazer-markdown-editor.css");
+const cssContent = readFileSync("src/blazer-markdown-editor.css", "utf8");
+writeFileSync("wwwroot/blazer-markdown-editor.css", `${licenseHeader}${cssContent}`);
 
 let build;
 try {
@@ -17,6 +20,9 @@ const shared = {
   bundle: true,
   format: "iife",
   target: ["es2020"],
+  banner: {
+    js: licenseHeader,
+  },
 };
 
 await Promise.all([

wwwroot/blazer-markdown-editor.css

@@ -1,3 +1,6 @@
+// Copyright (c) 2026 David Walker
+// Licensed under the MIT License.
+
 .ProseMirror {
   background: #fff;
   border: 1px solid #d0d0d0;

wwwroot/blazer-markdown-editor.js

@@ -1,3 +1,6 @@
+// Copyright (c) 2026 David Walker
+// Licensed under the MIT License.
+
 (() => {
   var __defProp = Object.defineProperty;
   var __export = (target, all) => {