starlight-theme-celestia 0.3.0 → 0.3.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "starlight-theme-celestia",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "A clean, modern theme for Astro Starlight",
   "license": "MIT",
   "repository": {
@@ -28,6 +28,7 @@
   "dependencies": {
     "@aria-ui/core": "^0.2.0",
     "@aria-ui/utils": "^0.1.5",
+    "@astrojs/markdown-remark": "^7.3.0",
     "@fontsource/inter": "^5.0.0",
     "@pagefind/default-ui": "^1.5.2",
     "@shikijs/transformers": "^4.0.2",
@@ -38,7 +39,7 @@
     "rehype": "^13.0.2",
     "remark-custom-header-id": "^1.0.0",
     "shiki-twoslash-renderer": "^0.3.3",
-    "starlight-versions": "^0.9.0"
+    "starlight-versions": "^0.10.0"
   },
   "peerDependencies": {
     "@astrojs/starlight": "*",
@@ -53,7 +54,7 @@
     }
   },
   "devDependencies": {
-    "@astrojs/starlight": "^0.41.0",
+    "@astrojs/starlight": "^0.42.0",
     "@tailwindcss/cli": "^4.2.2",
     "@tailwindcss/vite": "^4.2.2",
     "@types/node": "^26.0.0",

package/src/index.test.ts

@@ -1,4 +1,7 @@
+import { unified } from "@astrojs/markdown-remark";
 import type { StarlightPlugin, StarlightUserConfig } from "@astrojs/starlight/types";
+import type { AstroConfig, AstroIntegration, AstroUserConfig } from "astro";
+import { mergeConfig } from "astro/config";
 import { expect, test } from "bun:test";
 
 import starlightCelestiaTheme from "./index";
@@ -57,3 +60,67 @@ test("a user override of the sidebar wins over the multi-sidebar one", async ()
 
   expect(config.components?.Sidebar).toBe("./src/components/Sidebar.astro");
 });
+
+async function setupMarkdown(markdown: AstroUserConfig["markdown"] = {}) {
+  let integration: AstroIntegration | undefined;
+  await starlightCelestiaTheme().hooks["config:setup"]!({
+    config: {},
+    updateConfig: () => {},
+    addIntegration: (value: AstroIntegration) => {
+      integration = value;
+    },
+    astroConfig: { root: new URL("file:///project/"), vite: {} },
+  } as unknown as ConfigSetupOptions);
+
+  const hook = integration!.hooks["astro:config:setup"]!;
+  let result: AstroUserConfig = { markdown };
+  await hook({
+    config: { markdown } as AstroConfig,
+    updateConfig: (value: AstroUserConfig) => {
+      result = mergeConfig(result, value);
+      return result;
+    },
+  } as unknown as Parameters<typeof hook>[0]);
+  return result.markdown!;
+}
+
+test("the theme uses unified to render custom heading IDs with a non-unified processor configured", async () => {
+  const markdown = await setupMarkdown({
+    processor: {
+      name: "satteri",
+      options: {},
+      createRenderer: async () => {
+        throw new Error("the incompatible processor must not render theme Markdown");
+      },
+    },
+  });
+  expect(markdown.processor!.name).toBe("unified");
+  expect(markdown.remarkPlugins).toBeUndefined();
+  const renderer = await markdown.processor!.createRenderer({});
+  const result = await renderer.render("## A heading {#custom-id}");
+  expect(result.code).toContain('id="custom-id"');
+  expect(result.code).not.toContain("{#custom-id}");
+});
+
+test("the theme preserves an existing unified processor and shared Markdown settings", async () => {
+  const remarkPlugin = () => () => {};
+  const rehypePlugin = () => () => {};
+  const recmaPlugin = () => () => {};
+  const processor = unified({
+    remarkPlugins: [remarkPlugin],
+    rehypePlugins: [rehypePlugin],
+    recmaPlugins: [recmaPlugin],
+    remarkRehype: { clobberPrefix: "user-" },
+    gfm: false,
+    smartypants: false,
+  });
+  const markdown = await setupMarkdown({ processor, syntaxHighlight: false });
+  expect(markdown.processor).toBe(processor);
+  expect(processor.options.remarkPlugins[0]).toBe(remarkPlugin);
+  expect(processor.options.rehypePlugins).toEqual([rehypePlugin]);
+  expect(processor.options.recmaPlugins).toEqual([recmaPlugin]);
+  expect(processor.options.remarkRehype).toEqual({ clobberPrefix: "user-" });
+  expect(processor.options.gfm).toBe(false);
+  expect(processor.options.smartypants).toBe(false);
+  expect(markdown.syntaxHighlight).toBe(false);
+});

package/src/index.ts

@@ -1,3 +1,4 @@
+import { isUnifiedProcessor, unified } from "@astrojs/markdown-remark";
 import type { StarlightConfig, StarlightPlugin, StarlightUserConfig } from "@astrojs/starlight/types";
 import type { AstroConfig } from "astro";
 import remarkCustomHeaderId from "remark-custom-header-id";
@@ -72,11 +73,17 @@ export default function starlightCelestiaTheme(options: ThemeCelestiaOptions = {
         addIntegration({
           name: "starlight-theme-celestia-integration",
           hooks: {
-            "astro:config:setup": ({ updateConfig }) => {
+            "astro:config:setup": ({ config, updateConfig }) => {
+              // Reuse unified so user options and Astro's legacy-plugin migration tracking survive.
+              // Astro migrates any top-level remark/rehype settings when updateConfig validates this processor.
+              const currentProcessor = config.markdown.processor;
+              const processor = currentProcessor && isUnifiedProcessor(currentProcessor) ? currentProcessor : unified();
+              processor.options.remarkPlugins.push(remarkCustomHeaderId);
+
               updateConfig({
                 markdown: {
                   shikiConfig: createShikiConfig({ twoslash: true }),
-                  remarkPlugins: [remarkCustomHeaderId],
+                  processor,
                 },
                 vite: {
                   plugins: [

package/src/shiki-transformer-container.ts

@@ -104,7 +104,7 @@ export function transformerContainer(): ShikiTransformer {
   };
 }
 
-// A simple function to make typescript happy
+// Root-only nodes, including MDX module declarations, cannot be nested inside an element.
 function normalizeContent(children: RootContent[]): ElementContent[] {
-  return children.filter((child) => child.type !== "doctype");
+  return children.filter((child): child is ElementContent => !["doctype", "mdxjsEsm"].includes(child.type));
 }

package/src/virtual-starlight.d.ts

@@ -0,0 +1,4 @@
+declare module "virtual:starlight/user-config" {
+  const config: import("@astrojs/starlight/types").StarlightConfig;
+  export default config;
+}