starlight-cannoli-plugins 2.3.0 → 2.3.2

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/chunk-XMGAWBJ5.js

@@ -0,0 +1,48 @@
+// src/plugins/starlight-dom-patches/index.ts
+import { fileURLToPath } from "url";
+function starlightDomPatches(options = {}) {
+  const {
+    hideSingleLineGutters = false,
+    syncTocLabelsFromHeadings = false,
+    wrapDetailsContent = false
+  } = options;
+  return {
+    name: "starlight-dom-patches",
+    hooks: {
+      "astro:config:setup": ({ injectScript }) => {
+        const currentFile = fileURLToPath(import.meta.url);
+        let pageScriptUrl;
+        if (currentFile.endsWith(".ts")) {
+          pageScriptUrl = new URL("./page-script.ts", import.meta.url);
+        } else if (currentFile.endsWith("starlight-dom-patches.js")) {
+          pageScriptUrl = new URL(
+            "./starlight-dom-patches/page-script.js",
+            import.meta.url
+          );
+        } else {
+          pageScriptUrl = new URL(
+            "./plugins/starlight-dom-patches/page-script.js",
+            import.meta.url
+          );
+        }
+        const scriptPath = JSON.stringify(fileURLToPath(pageScriptUrl));
+        const imports = [
+          hideSingleLineGutters ? "hideSingleLineGutters" : null,
+          syncTocLabelsFromHeadings ? "syncTocLabelsFromHeadings" : null,
+          wrapDetailsContent ? "wrapDetailsContent" : null
+        ].filter(Boolean);
+        if (imports.length === 0) return;
+        const calls = imports.map((fn) => `${fn}();`).join("\n");
+        injectScript(
+          "page",
+          `import { ${imports.join(", ")} } from ${scriptPath};
+${calls}`
+        );
+      }
+    }
+  };
+}
+
+export {
+  starlightDomPatches
+};

package/dist/cpp-VZKLUKT7.js

@@ -3,8 +3,8 @@ import {
 } from "./chunk-ICUS267J.js";
 import "./chunk-MT4FGOLU.js";
 import "./chunk-YJV35WLF.js";
-import "./chunk-XOMTOLBK.js";
 import "./chunk-IWM27JZF.js";
+import "./chunk-XOMTOLBK.js";
 import "./chunk-QGM4M3NI.js";
 export {
   cpp_default as default

package/dist/{erb-WAGUANI2.js → erb-C5YNYGRU.js}

@@ -1,17 +1,17 @@
 import {
   ruby_default
-} from "./chunk-7DJE5LRN.js";
+} from "./chunk-VX22H7BZ.js";
+import "./chunk-S3SFQXYS.js";
 import "./chunk-ZSX4GOHC.js";
+import "./chunk-NE25QJUZ.js";
 import "./chunk-OII47WE4.js";
 import "./chunk-76C5RMV7.js";
-import "./chunk-S3SFQXYS.js";
-import "./chunk-NE25QJUZ.js";
 import "./chunk-ICUS267J.js";
 import "./chunk-MT4FGOLU.js";
 import "./chunk-YJV35WLF.js";
 import "./chunk-5TDK5Y5S.js";
-import "./chunk-XOMTOLBK.js";
 import "./chunk-IWM27JZF.js";
+import "./chunk-XOMTOLBK.js";
 import "./chunk-VB3O6QM4.js";
 import "./chunk-QFOAKHDY.js";
 import "./chunk-AZIN3OHL.js";

package/dist/index.d.ts

@@ -1,27 +1,16 @@
 export { starlightIndexOnlySidebar } from './plugins/starlight-index-only-sidebar.js';
-import { AstroIntegration } from 'astro';
+export { DomPatchesOptions, starlightDomPatches } from './plugins/starlight-dom-patches.js';
 export { SyncDocsToPublicOptions, syncDocsToPublic } from './plugins/astro-sync-docs-to-public.js';
 export { default as rehypeValidateLinks } from './plugins/rehype-validate-links.js';
 export { astroNormalizePaths } from './plugins/astro-normalize-paths.js';
 import { RemarkLatexCompileOptions } from './plugins/astro-latex-compile.js';
 export { default as remarkLatexCompile } from './plugins/astro-latex-compile.js';
+import { AstroIntegration } from 'astro';
 import '@astrojs/starlight/types';
 import 'hast';
 import 'vfile';
 import 'mdast';
 
-interface DomPatchesOptions {
-    /** Hide line number gutters on single-line code blocks. @default false */
-    hideSingleLineGutters?: boolean;
-    /** Wrap `<details>` content (excluding `<summary>`) in a `.details-wrapper` div. @default false */
-    wrapDetailsContent?: boolean;
-}
-/**
- * Astro integration that injects a client-side script to apply DOM patches
- * on every page. Each patch can be individually enabled or disabled via options.
- */
-declare function starlightDomPatches(options?: DomPatchesOptions): AstroIntegration;
-
 interface LatexCompileOptions extends RemarkLatexCompileOptions {
     /**
      * When `true`, SVG files in `svgOutputDir` that are no longer referenced by
@@ -34,4 +23,4 @@ interface LatexCompileOptions extends RemarkLatexCompileOptions {
 }
 declare function astroLatexCompile(options: LatexCompileOptions): AstroIntegration;
 
-export { type DomPatchesOptions, type LatexCompileOptions, astroLatexCompile, starlightDomPatches };
+export { type LatexCompileOptions, astroLatexCompile };

package/dist/index.js

@@ -14,48 +14,11 @@ import {
   syncDocsToPublic
 } from "./chunk-WZNJ5VFU.js";
 import "./chunk-IY4A67ZP.js";
+import {
+  starlightDomPatches
+} from "./chunk-XMGAWBJ5.js";
 import "./chunk-QGM4M3NI.js";
 
-// src/plugins/starlight-dom-patches/index.ts
-import { fileURLToPath } from "url";
-function starlightDomPatches(options = {}) {
-  const { hideSingleLineGutters = false, wrapDetailsContent = false } = options;
-  return {
-    name: "starlight-dom-patches",
-    hooks: {
-      "astro:config:setup": ({ injectScript }) => {
-        const currentFile = fileURLToPath(import.meta.url);
-        let pageScriptUrl;
-        if (currentFile.endsWith(".ts")) {
-          pageScriptUrl = new URL("./page-script.ts", import.meta.url);
-        } else if (currentFile.endsWith("starlight-dom-patches.js")) {
-          pageScriptUrl = new URL(
-            "./starlight-dom-patches/page-script.js",
-            import.meta.url
-          );
-        } else {
-          pageScriptUrl = new URL(
-            "./plugins/starlight-dom-patches/page-script.js",
-            import.meta.url
-          );
-        }
-        const scriptPath = JSON.stringify(fileURLToPath(pageScriptUrl));
-        const imports = [
-          hideSingleLineGutters ? "hideSingleLineGutters" : null,
-          wrapDetailsContent ? "wrapDetailsContent" : null
-        ].filter(Boolean);
-        if (imports.length === 0) return;
-        const calls = imports.map((fn) => `${fn}();`).join("\n");
-        injectScript(
-          "page",
-          `import { ${imports.join(", ")} } from ${scriptPath};
-${calls}`
-        );
-      }
-    }
-  };
-}
-
 // src/plugins/astro-latex-compile/astro-integration.ts
 import fs from "fs";
 import { readdir, rm } from "fs/promises";

package/dist/{just-PYDV7ZQ7.js → just-AKSNMXKO.js}

@@ -3,23 +3,23 @@ import {
 } from "./chunk-Z2VUFOSG.js";
 import {
   ruby_default
-} from "./chunk-7DJE5LRN.js";
+} from "./chunk-VX22H7BZ.js";
+import "./chunk-S3SFQXYS.js";
 import "./chunk-ZSX4GOHC.js";
+import "./chunk-NE25QJUZ.js";
 import "./chunk-OII47WE4.js";
 import "./chunk-76C5RMV7.js";
-import "./chunk-S3SFQXYS.js";
-import "./chunk-NE25QJUZ.js";
 import "./chunk-ICUS267J.js";
 import "./chunk-MT4FGOLU.js";
 import "./chunk-YJV35WLF.js";
 import {
   shellscript_default
 } from "./chunk-5TDK5Y5S.js";
-import "./chunk-XOMTOLBK.js";
 import {
   python_default
 } from "./chunk-QH2T6GYZ.js";
 import "./chunk-IWM27JZF.js";
+import "./chunk-XOMTOLBK.js";
 import {
   typescript_default
 } from "./chunk-VB3O6QM4.js";

package/dist/plugins/starlight-dom-patches/page-script.d.ts

@@ -0,0 +1,5 @@
+declare function hideSingleLineGutters(): void;
+declare function syncTocLabelsFromHeadings(): void;
+declare function wrapDetailsContent(): void;
+
+export { hideSingleLineGutters, syncTocLabelsFromHeadings, wrapDetailsContent };

package/dist/plugins/starlight-dom-patches/page-script.js

@@ -0,0 +1,65 @@
+import "../../chunk-QGM4M3NI.js";
+
+// src/plugins/starlight-dom-patches/page-script.ts
+function hideSingleLineGutters() {
+  console.log("Hiding Single Line Gutters");
+  const codeElements = document.querySelectorAll(
+    "div.expressive-code > figure > pre > code"
+  );
+  codeElements.forEach((codeElement) => {
+    const lineElements = codeElement.querySelectorAll("div.ec-line");
+    if (lineElements.length === 1) {
+      const gutter = lineElements[0].querySelector("div.gutter");
+      if (gutter) {
+        gutter.classList.add("visually-hidden");
+      }
+    }
+  });
+}
+function syncTocLabelsFromHeadings() {
+  document.querySelectorAll("starlight-toc ul li > a").forEach((anchor) => {
+    const href = anchor.getAttribute("href") ?? "";
+    const hashIndex = href.indexOf("#");
+    if (hashIndex === -1) return;
+    const id = href.slice(hashIndex + 1);
+    if (id == "_top") return;
+    const heading = document.getElementById(id);
+    if (!heading) return;
+    const span = anchor.querySelector(":scope > span");
+    if (!span) return;
+    span.innerHTML = heading.innerHTML;
+  });
+}
+function wrapDetailsContent() {
+  console.log("Wrapping details element contents");
+  const detailsElements = document.querySelectorAll(".main-pane details");
+  detailsElements.forEach((details) => {
+    if (details.children.length === 0) return;
+    const summary = details.querySelector(":scope > summary");
+    if (!summary) {
+      const wrapper = document.createElement("div");
+      wrapper.className = "details-wrapper";
+      while (details.children.length > 0) {
+        wrapper.appendChild(details.children[0]);
+      }
+      details.appendChild(wrapper);
+    } else {
+      const wrapper = document.createElement("div");
+      wrapper.className = "details-wrapper";
+      const childrenToWrap = Array.from(details.children).filter(
+        (child) => child !== summary
+      );
+      childrenToWrap.forEach((child) => {
+        wrapper.appendChild(child);
+      });
+      details.innerHTML = "";
+      details.appendChild(summary);
+      details.appendChild(wrapper);
+    }
+  });
+}
+export {
+  hideSingleLineGutters,
+  syncTocLabelsFromHeadings,
+  wrapDetailsContent
+};

package/dist/plugins/starlight-dom-patches.d.ts

@@ -0,0 +1,17 @@
+import { AstroIntegration } from 'astro';
+
+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;
+}
+/**
+ * Astro integration that injects a client-side script to apply DOM patches
+ * on every page. Each patch can be individually enabled or disabled via options.
+ */
+declare function starlightDomPatches(options?: DomPatchesOptions): AstroIntegration;
+
+export { type DomPatchesOptions, starlightDomPatches };

package/dist/plugins/starlight-dom-patches.js

@@ -0,0 +1,7 @@
+import {
+  starlightDomPatches
+} from "../chunk-XMGAWBJ5.js";
+import "../chunk-QGM4M3NI.js";
+export {
+  starlightDomPatches
+};

package/dist/{rst-V6D7WWXH.js → rst-CWLRMHAC.js}

@@ -1,13 +1,13 @@
 import {
   ruby_default
-} from "./chunk-7DJE5LRN.js";
+} from "./chunk-VX22H7BZ.js";
+import "./chunk-S3SFQXYS.js";
 import "./chunk-ZSX4GOHC.js";
+import "./chunk-NE25QJUZ.js";
 import "./chunk-OII47WE4.js";
 import {
   yaml_default
 } from "./chunk-76C5RMV7.js";
-import "./chunk-S3SFQXYS.js";
-import "./chunk-NE25QJUZ.js";
 import {
   cpp_default
 } from "./chunk-ICUS267J.js";
@@ -16,17 +16,17 @@ import "./chunk-YJV35WLF.js";
 import {
   shellscript_default
 } from "./chunk-5TDK5Y5S.js";
-import {
-  cmake_default
-} from "./chunk-CYKSS2Y7.js";
-import "./chunk-XOMTOLBK.js";
 import {
   python_default
 } from "./chunk-QH2T6GYZ.js";
+import {
+  cmake_default
+} from "./chunk-CYKSS2Y7.js";
 import {
   html_derivative_default
 } from "./chunk-HO32H4C2.js";
 import "./chunk-IWM27JZF.js";
+import "./chunk-XOMTOLBK.js";
 import "./chunk-VB3O6QM4.js";
 import "./chunk-QFOAKHDY.js";
 import "./chunk-AZIN3OHL.js";

package/dist/{ruby-QQFN2P53.js → ruby-FV4CBPPY.js}

@@ -1,17 +1,17 @@
 import {
   ruby_default
-} from "./chunk-7DJE5LRN.js";
+} from "./chunk-VX22H7BZ.js";
+import "./chunk-S3SFQXYS.js";
 import "./chunk-ZSX4GOHC.js";
+import "./chunk-NE25QJUZ.js";
 import "./chunk-OII47WE4.js";
 import "./chunk-76C5RMV7.js";
-import "./chunk-S3SFQXYS.js";
-import "./chunk-NE25QJUZ.js";
 import "./chunk-ICUS267J.js";
 import "./chunk-MT4FGOLU.js";
 import "./chunk-YJV35WLF.js";
 import "./chunk-5TDK5Y5S.js";
-import "./chunk-XOMTOLBK.js";
 import "./chunk-IWM27JZF.js";
+import "./chunk-XOMTOLBK.js";
 import "./chunk-VB3O6QM4.js";
 import "./chunk-QFOAKHDY.js";
 import "./chunk-AZIN3OHL.js";

package/dist/{twig-CHAFMQ5H.js → twig-A32UUER2.js}

@@ -3,23 +3,26 @@ import {
 } from "./chunk-LU63TSZZ.js";
 import {
   ruby_default
-} from "./chunk-7DJE5LRN.js";
+} from "./chunk-VX22H7BZ.js";
+import "./chunk-S3SFQXYS.js";
 import "./chunk-ZSX4GOHC.js";
+import "./chunk-NE25QJUZ.js";
 import "./chunk-OII47WE4.js";
 import "./chunk-76C5RMV7.js";
-import "./chunk-S3SFQXYS.js";
-import "./chunk-NE25QJUZ.js";
 import "./chunk-ICUS267J.js";
 import "./chunk-MT4FGOLU.js";
 import "./chunk-YJV35WLF.js";
 import "./chunk-5TDK5Y5S.js";
-import "./chunk-XOMTOLBK.js";
 import {
   python_default
 } from "./chunk-QH2T6GYZ.js";
 import "./chunk-IWM27JZF.js";
+import "./chunk-XOMTOLBK.js";
 import "./chunk-VB3O6QM4.js";
 import "./chunk-QFOAKHDY.js";
+import {
+  scss_default
+} from "./chunk-3TOTNBUR.js";
 import "./chunk-AZIN3OHL.js";
 import "./chunk-YBPIMBI6.js";
 import "./chunk-GL2Q3EDW.js";
@@ -27,9 +30,6 @@ import "./chunk-L4TNW36O.js";
 import {
   javascript_default
 } from "./chunk-2QHMH6QB.js";
-import {
-  scss_default
-} from "./chunk-3TOTNBUR.js";
 import {
   css_default
 } from "./chunk-MQJVB2GB.js";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "starlight-cannoli-plugins",
   "type": "module",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "description": "Starlight plugins for automatic sidebar generation and link validation",
   "license": "ISC",
   "main": "./dist/index.js",
@@ -34,6 +34,10 @@
       "import": "./dist/plugins/astro-sync-docs-to-public.js",
       "types": "./dist/plugins/astro-sync-docs-to-public.d.ts"
     },
+    "./starlight-dom-patches": {
+      "import": "./dist/plugins/starlight-dom-patches.js",
+      "types": "./dist/plugins/starlight-dom-patches.d.ts"
+    },
     "./styles": "./dist/styles/",
     "./styles/*": "./dist/styles/*"
   },

package/dist/{angular-ts-GBZ7GNXU.js → angular-ts-WMP65SON.js}

@@ -1,3 +1,6 @@
+import {
+  scss_default
+} from "./chunk-3TOTNBUR.js";
 import {
   angular_expression_default,
   angular_html_default,
@@ -7,9 +10,6 @@ import {
 } from "./chunk-VN4MPI3U.js";
 import "./chunk-L4TNW36O.js";
 import "./chunk-2QHMH6QB.js";
-import {
-  scss_default
-} from "./chunk-3TOTNBUR.js";
 import "./chunk-MQJVB2GB.js";
 import "./chunk-QGM4M3NI.js";
 

package/dist/{chunk-7DJE5LRN.js → chunk-VX22H7BZ.js}

@@ -1,3 +1,6 @@
+import {
+  haml_default
+} from "./chunk-S3SFQXYS.js";
 import {
   graphql_default
 } from "./chunk-ZSX4GOHC.js";
@@ -7,21 +10,18 @@ import {
 import {
   yaml_default
 } from "./chunk-76C5RMV7.js";
-import {
-  haml_default
-} from "./chunk-S3SFQXYS.js";
 import {
   cpp_default
 } from "./chunk-ICUS267J.js";
 import {
   shellscript_default
 } from "./chunk-5TDK5Y5S.js";
-import {
-  c_default
-} from "./chunk-XOMTOLBK.js";
 import {
   sql_default
 } from "./chunk-IWM27JZF.js";
+import {
+  c_default
+} from "./chunk-XOMTOLBK.js";
 import {
   xml_default
 } from "./chunk-AZIN3OHL.js";

package/dist/{crystal-MYUTTSDY.js → crystal-OIARPJAM.js}

@@ -1,12 +1,12 @@
 import {
   shellscript_default
 } from "./chunk-5TDK5Y5S.js";
-import {
-  c_default
-} from "./chunk-XOMTOLBK.js";
 import {
   sql_default
 } from "./chunk-IWM27JZF.js";
+import {
+  c_default
+} from "./chunk-XOMTOLBK.js";
 import {
   html_default
 } from "./chunk-L4TNW36O.js";

package/dist/{gdresource-4KLMUJAA.js → gdresource-NUFTOCJI.js}

@@ -1,9 +1,9 @@
-import {
-  gdshader_default
-} from "./chunk-45O7TJOW.js";
 import {
   gdscript_default
 } from "./chunk-YWWGTQZD.js";
+import {
+  gdshader_default
+} from "./chunk-45O7TJOW.js";
 import "./chunk-QGM4M3NI.js";
 
 // node_modules/@shikijs/langs/dist/gdresource.mjs

package/dist/{julia-VFJDJOWL.js → julia-ZINCBU7F.js}

@@ -6,13 +6,13 @@ import {
 } from "./chunk-ICUS267J.js";
 import "./chunk-MT4FGOLU.js";
 import "./chunk-YJV35WLF.js";
-import "./chunk-XOMTOLBK.js";
 import {
   python_default
 } from "./chunk-QH2T6GYZ.js";
 import {
   sql_default
 } from "./chunk-IWM27JZF.js";
+import "./chunk-XOMTOLBK.js";
 import {
   javascript_default
 } from "./chunk-2QHMH6QB.js";

package/dist/{ts-tags-O77G7HGT.js → ts-tags-DME2ZSNV.js}

@@ -1,10 +1,10 @@
 import {
   glsl_default
 } from "./chunk-YJV35WLF.js";
-import "./chunk-XOMTOLBK.js";
 import {
   sql_default
 } from "./chunk-IWM27JZF.js";
+import "./chunk-XOMTOLBK.js";
 import {
   typescript_default
 } from "./chunk-VB3O6QM4.js";

package/dist/{vue-vine-2IO2MJQD.js → vue-vine-VT7KMRSF.js}

@@ -7,12 +7,12 @@ import {
 import {
   postcss_default
 } from "./chunk-3BGADQKG.js";
-import {
-  javascript_default
-} from "./chunk-2QHMH6QB.js";
 import {
   scss_default
 } from "./chunk-3TOTNBUR.js";
+import {
+  javascript_default
+} from "./chunk-2QHMH6QB.js";
 import {
   css_default
 } from "./chunk-MQJVB2GB.js";