nizel-kit 0.1.0 → 0.1.1

package/README.md

@@ -4,6 +4,12 @@ Browser and native WebView integration bundle for Nizel.
 
 `nizel-kit` packages the browser renderer plus a registry of official plugins. Native apps can show settings from `supportedPlugins`, store selected plugin IDs, and pass those IDs back to the renderer. The Swift app does not need to parse or convert Markdown extension syntax.
 
+## Install
+
+```bash
+npm install nizel-kit
+```
+
 ## Browser / IIFE
 
 Use `dist/nizel-kit.iife.js` in `WKWebView`, `JSContext`, or a browser shell. It exposes `NizelKit`.
@@ -32,3 +38,35 @@ let enabledPlugins = ["alert", "math", "typography"]
 Then pass that array into JavaScript when rendering.
 
 Code-rendering plugins use `exclusiveGroup: "code-renderer"`. If multiple code renderers are selected, `nizel-kit` keeps the last selected one so the renderer remains deterministic.
+
+## API
+
+- `supportedPlugins` - serializable plugin metadata for settings screens.
+- `defaultEnabledPlugins()` - plugin IDs enabled by default.
+- `normalizeEnabledPlugins(ids)` - validates plugin IDs and resolves exclusive groups.
+- `createPlugins(ids, pluginOptions)` - returns Nizel plugin instances.
+- `useNizelKit(options)` - creates a browser processor with selected plugins.
+- `markdownToHtml(markdown, options)` - renders Markdown to HTML.
+- `mountMarkdown(target, markdown, options)` - renders into a browser/WebView DOM target.
+
+## Plugin IDs
+
+`abbr`, `alert`, `autolink`, `citations`, `code-copy`, `deflist`, `details`, `diagrams`, `emoji`, `footnotes`, `frontmatter-ui`, `gfm`, `heading-anchors`, `math`, `media`, `sanitize`, `shiki`, `toc`, and `typography`.
+
+## Swift / WebView Shape
+
+```swift
+struct NizelPluginSetting: Codable, Identifiable {
+    let id: String
+    let label: String
+    let description: String
+    let defaultEnabled: Bool
+    let category: String
+}
+```
+
+Load `nizel-kit.iife.js`, read `NizelKit.supportedPlugins` to build the settings UI, persist selected IDs, and call `NizelKit.markdownToHtml(markdown, { enabledPlugins })` when rendering.
+
+## License
+
+MIT

package/dist/nizel-kit.iife.js

@@ -155,8 +155,18 @@ var NizelKit = (() => {
     if (node.tag === "code" || node.tag === "pre") {
       return names.some((name) => name !== "class") || !/\blanguage-[A-Za-z0-9_-]+/.test(node.attrs.class ?? "");
     }
+    if (/^h[1-6]$/.test(node.tag)) {
+      return names.some((name) => {
+        if (name !== "id")
+          return true;
+        return node.attrs.id !== slugifyText(textContent(node));
+      });
+    }
     return true;
   }
+  function slugifyText(value) {
+    return value.toLowerCase().replace(/[^\w\s-]/g, "").replace(/[\s_]+/g, "-").replace(/^-+|-+$/g, "");
+  }
   function renderChildren(nodes, options, depth) {
     return nodes.map((node) => renderNode(node, options, depth)).join("");
   }

package/dist/nizel-kit.js

@@ -123,8 +123,18 @@ function hasUnsupportedAttrs(node) {
   if (node.tag === "code" || node.tag === "pre") {
     return names.some((name) => name !== "class") || !/\blanguage-[A-Za-z0-9_-]+/.test(node.attrs.class ?? "");
   }
+  if (/^h[1-6]$/.test(node.tag)) {
+    return names.some((name) => {
+      if (name !== "id")
+        return true;
+      return node.attrs.id !== slugifyText(textContent(node));
+    });
+  }
   return true;
 }
+function slugifyText(value) {
+  return value.toLowerCase().replace(/[^\w\s-]/g, "").replace(/[\s_]+/g, "-").replace(/^-+|-+$/g, "");
+}
 function renderChildren(nodes, options, depth) {
   return nodes.map((node) => renderNode(node, options, depth)).join("");
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nizel-kit",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Browser and native WebView integration kit for Nizel with official plugin registry.",
   "repository": {
     "type": "git",
@@ -28,7 +28,8 @@
     "build:browser": "esbuild src/index.ts --bundle --platform=browser --format=esm --target=safari14 --outfile=dist/nizel-kit.js && esbuild src/index.ts --bundle --platform=browser --format=iife --global-name=NizelKit --target=safari14 --outfile=dist/nizel-kit.iife.js",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "test": "npm run build && vitest run test/*.mjs",
-    "test:watch": "npm run build && vitest test/*.mjs"
+    "test:watch": "npm run build && vitest test/*.mjs",
+    "test:run": "vitest run test/*.mjs"
   },
   "dependencies": {
     "nizel": "^0.1.0",