starlight-cannoli-plugins 2.3.0 → 2.3.1

package/README.md

@@ -317,6 +317,36 @@ syncDocsToPublic({
 });
 ```
 
+### Starlight DOM Patches
+
+An Astro integration that injects a client-side script to apply opt-in DOM patches on every page. Each patch is disabled by default and must be explicitly enabled.
+
+**Options:**
+
+- `hideSingleLineGutters` (optional, default: `false`): Hides the line number gutter on Expressive Code blocks that contain only a single line.
+- `syncTocLabelsFromHeadings` (optional, default: `false`): Copies the rendered HTML of each heading into its matching Starlight TOC anchor label, so the TOC properly reflects any custom markup (e.g. math) present in the heading.
+- `wrapDetailsContent` (optional, default: `false`): Wraps the content of every `<details>` element (excluding its `<summary>`) in a `<div class="details-wrapper">`, useful for applying consistent spacing or animation styles.
+
+**Usage:**
+
+```ts
+// astro.config.mjs
+import { defineConfig } from "astro/config";
+import starlight from "@astrojs/starlight";
+import { starlightDomPatches } from "starlight-cannoli-plugins";
+
+export default defineConfig({
+  integrations: [
+    starlightDomPatches({
+      hideSingleLineGutters: true,
+      syncTocLabelsFromHeadings: true,
+      wrapDetailsContent: true,
+    }),
+    starlight({ title: "My Docs" }),
+  ],
+});
+```
+
 ## CLI Utilities
 
 ### cannoli-latex-cleanup

package/dist/index.d.ts

@@ -13,6 +13,8 @@ import 'mdast';
 interface DomPatchesOptions {
     /** Hide line number gutters on single-line code blocks. @default false */
     hideSingleLineGutters?: boolean;
+    /** Copy rendered heading innerHTML into matching Starlight TOC anchor labels. @default false */
+    syncTocLabelsFromHeadings?: boolean;
     /** Wrap `<details>` content (excluding `<summary>`) in a `.details-wrapper` div. @default false */
     wrapDetailsContent?: boolean;
 }

package/dist/index.js

@@ -19,7 +19,11 @@ import "./chunk-QGM4M3NI.js";
 // src/plugins/starlight-dom-patches/index.ts
 import { fileURLToPath } from "url";
 function starlightDomPatches(options = {}) {
-  const { hideSingleLineGutters = false, wrapDetailsContent = false } = options;
+  const {
+    hideSingleLineGutters = false,
+    syncTocLabelsFromHeadings = false,
+    wrapDetailsContent = false
+  } = options;
   return {
     name: "starlight-dom-patches",
     hooks: {
@@ -42,6 +46,7 @@ function starlightDomPatches(options = {}) {
         const scriptPath = JSON.stringify(fileURLToPath(pageScriptUrl));
         const imports = [
           hideSingleLineGutters ? "hideSingleLineGutters" : null,
+          syncTocLabelsFromHeadings ? "syncTocLabelsFromHeadings" : null,
           wrapDetailsContent ? "wrapDetailsContent" : null
         ].filter(Boolean);
         if (imports.length === 0) return;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "starlight-cannoli-plugins",
   "type": "module",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "Starlight plugins for automatic sidebar generation and link validation",
   "license": "ISC",
   "main": "./dist/index.js",