@astrojs/starlight 0.41.10 → 0.42.0

package/dist/utils/plugins.d.ts

@@ -0,0 +1,721 @@
+import { LinkHTMLAttributes } from "../schemas/sidebar.js";
+import { StarlightUserConfig } from "./user-config.js";
+import { UserI18nSchema } from "./translations.js";
+import { I18nT } from "./createTranslationSystem.js";
+import { createTranslationSystemFromFs } from "./translations-fs.js";
+import { StarlightExpressiveCodeOptions } from "../integrations/expressive-code/index.js";
+import "../expressive-code.js";
+import { z } from "astro/zod";
+import { AstroIntegration, HookParameters as HookParameters$1 } from "astro";
+//#region src/utils/plugins.d.ts
+/**
+ * Runs Starlight plugins in the order that they are configured after validating the user-provided
+ * configuration and returns the final validated user config that may have been updated by the
+ * plugins and a list of any integrations added by the plugins.
+ */
+declare function runPlugins(starlightUserConfig: StarlightUserConfig, pluginsUserConfig: StarlightPluginsUserConfig, context: StarlightPluginContext): Promise<{
+  integrations: AstroIntegration[];
+  starlightConfig: {
+    readonly title: Record<string, string>;
+    readonly isMultilingual: boolean;
+    readonly isUsingBuiltInDefaultLocale: false;
+    readonly defaultLocale: {
+      readonly locale: string | undefined;
+      readonly label: string;
+      readonly dir: "rtl" | "ltr";
+      readonly lang?: string | undefined;
+    };
+    readonly locales: {
+      [x: string]: {
+        label: string;
+        dir: "rtl" | "ltr";
+        lang?: string | undefined;
+      };
+      root?: {
+        label: string;
+        lang: string;
+        dir: "rtl" | "ltr";
+      } | undefined;
+    };
+    readonly pagefind: false | {
+      ranking: {
+        pageLength: number;
+        termFrequency: number;
+        termSaturation: number;
+        termSimilarity: number;
+        diacriticSimilarity: number;
+        metaWeights?: Record<string, number> | undefined;
+      };
+      indexWeight?: number | undefined;
+      mergeIndex?: {
+        bundlePath: string;
+        ranking: {
+          pageLength: number;
+          termFrequency: number;
+          termSaturation: number;
+          termSimilarity: number;
+          diacriticSimilarity: number;
+          metaWeights?: Record<string, number> | undefined;
+        };
+        basePath?: string | undefined;
+        baseUrl?: string | undefined;
+        indexWeight?: number | undefined;
+        mergeFilter?: Record<string, string | [string, ...string[]]> | undefined;
+        language?: string | undefined;
+      }[] | undefined;
+    };
+    readonly tableOfContents: false | {
+      minHeadingLevel: number;
+      maxHeadingLevel: number;
+    } | {
+      minHeadingLevel: number;
+      maxHeadingLevel: number;
+    };
+    readonly editLink: {
+      baseUrl?: string | undefined;
+    };
+    readonly head: {
+      tag: "base" | "link" | "meta" | "noscript" | "script" | "style" | "template" | "title";
+      attrs?: Record<string, string | boolean | undefined> | undefined;
+      content?: string | undefined;
+    }[];
+    readonly customCss: string[];
+    readonly lastUpdated: boolean;
+    readonly pagination: boolean;
+    readonly favicon: {
+      href: string;
+      type: string;
+    };
+    readonly components: {
+      Head: string;
+      ThemeProvider: string;
+      SkipLink: string;
+      PageFrame: string;
+      MobileMenuToggle: string;
+      TwoColumnContent: string;
+      Header: string;
+      SiteTitle: string;
+      Search: string;
+      SocialIcons: string;
+      ThemeSelect: string;
+      LanguageSelect: string;
+      Sidebar: string;
+      MobileMenuFooter: string;
+      PageSidebar: string;
+      TableOfContents: string;
+      MobileTableOfContents: string;
+      Banner: string;
+      ContentPanel: string;
+      PageTitle: string;
+      FallbackContentNotice: string;
+      DraftContentNotice: string;
+      Hero: string;
+      MarkdownContent: string;
+      Footer: string;
+      LastUpdated: string;
+      Pagination: string;
+      EditLink: string;
+    };
+    readonly titleDelimiter: string;
+    readonly disable404Route: boolean;
+    readonly prerender: boolean;
+    readonly credits: boolean;
+    readonly routeMiddleware: string[];
+    readonly markdown: {
+      headingLinks: boolean;
+      processedDirs: string[];
+    };
+    readonly description?: string | undefined;
+    readonly logo?: {
+      src: string;
+      alt: string;
+      replacesTitle: boolean;
+    } | {
+      dark: string;
+      light: string;
+      alt: string;
+      replacesTitle: boolean;
+    } | undefined;
+    readonly social?: {
+      icon: "server" | "external" | "error" | "link" | "up-caret" | "down-caret" | "right-caret" | "left-caret" | "up-arrow" | "down-arrow" | "right-arrow" | "left-arrow" | "bars" | "translate" | "pencil" | "pen" | "document" | "add-document" | "setting" | "link-alt" | "download" | "cloud-download" | "moon" | "sun" | "clock" | "laptop" | "desktop" | "mobile-android" | "window" | "database" | "code-branch" | "open-book" | "notes" | "information" | "magnifier" | "forward-slash" | "close" | "warning" | "approve-check-circle" | "approve-check" | "question-circle" | "question" | "rocket" | "star" | "puzzle" | "list-format" | "analytics" | "random" | "padlock" | "comment" | "comment-alt" | "heart" | "github" | "gitlab" | "bitbucket" | "forgejo" | "codePen" | "farcaster" | "discord" | "gitter" | "twitter" | "x.com" | "mastodon" | "codeberg" | "youtube" | "threads" | "linkedin" | "twitch" | "azureDevOps" | "microsoftTeams" | "instagram" | "stackOverflow" | "telegram" | "whatsApp" | "rss" | "facebook" | "email" | "phone" | "reddit" | "patreon" | "signal" | "slack" | "matrix" | "hackerOne" | "openCollective" | "blueSky" | "discourse" | "zulip" | "pinterest" | "tiktok" | "goodreads" | "hypothesis" | "astro" | "solidjs" | "alpine" | "pnpm" | "biome" | "bun" | "mdx" | "apple" | "linux" | "homebrew" | "nix" | "starlight" | "pkl" | "node" | "cloudflare" | "vercel" | "netlify" | "deno" | "jsr" | "nostr" | "backstage" | "confluence" | "jira" | "storybook" | "vscode" | "jetbrains" | "zed" | "vim" | "figma" | "sketch" | "npm" | "npmx" | "sourcehut" | "substack" | "chrome" | "edge" | "firefox" | "safari" | "seti:folder" | "seti:bsl" | "seti:mdo" | "seti:salesforce" | "seti:asm" | "seti:bicep" | "seti:bazel" | "seti:c" | "seti:c-sharp" | "seti:html" | "seti:cpp" | "seti:clojure" | "seti:coldfusion" | "seti:config" | "seti:crystal" | "seti:crystal_embedded" | "seti:json" | "seti:css" | "seti:csv" | "seti:xls" | "seti:cu" | "seti:cake" | "seti:cake_php" | "seti:d" | "seti:word" | "seti:elixir" | "seti:elixir_script" | "seti:hex" | "seti:elm" | "seti:favicon" | "seti:f-sharp" | "seti:git" | "seti:go" | "seti:godot" | "seti:gradle" | "seti:grails" | "seti:graphql" | "seti:hacklang" | "seti:haml" | "seti:mustache" | "seti:haskell" | "seti:haxe" | "seti:jade" | "seti:java" | "seti:javascript" | "seti:jinja" | "seti:julia" | "seti:karma" | "seti:kotlin" | "seti:dart" | "seti:liquid" | "seti:livescript" | "seti:lua" | "seti:markdown" | "seti:argdown" | "seti:info" | "seti:clock" | "seti:maven" | "seti:nim" | "seti:github" | "seti:notebook" | "seti:nunjucks" | "seti:npm" | "seti:ocaml" | "seti:odata" | "seti:perl" | "seti:php" | "seti:pipeline" | "seti:pddl" | "seti:plan" | "seti:happenings" | "seti:powershell" | "seti:prisma" | "seti:pug" | "seti:puppet" | "seti:purescript" | "seti:python" | "seti:react" | "seti:rescript" | "seti:R" | "seti:ruby" | "seti:rust" | "seti:sass" | "seti:spring" | "seti:slim" | "seti:smarty" | "seti:sbt" | "seti:scala" | "seti:ethereum" | "seti:stylus" | "seti:svelte" | "seti:swift" | "seti:db" | "seti:terraform" | "seti:tex" | "seti:default" | "seti:twig" | "seti:typescript" | "seti:tsconfig" | "seti:vala" | "seti:vite" | "seti:vue" | "seti:wasm" | "seti:wat" | "seti:xml" | "seti:yml" | "seti:prolog" | "seti:zig" | "seti:zip" | "seti:wgt" | "seti:illustrator" | "seti:photoshop" | "seti:pdf" | "seti:font" | "seti:image" | "seti:svg" | "seti:sublime" | "seti:code-search" | "seti:shell" | "seti:video" | "seti:audio" | "seti:windows" | "seti:jenkins" | "seti:babel" | "seti:bower" | "seti:docker" | "seti:code-climate" | "seti:eslint" | "seti:firebase" | "seti:firefox" | "seti:gitlab" | "seti:grunt" | "seti:gulp" | "seti:ionic" | "seti:platformio" | "seti:rollup" | "seti:stylelint" | "seti:yarn" | "seti:webpack" | "seti:lock" | "seti:license" | "seti:makefile" | "seti:heroku" | "seti:todo" | "seti:ignored";
+      label: string;
+      href: string;
+    }[] | undefined;
+    readonly sidebar?: (({
+      collapsed: boolean;
+      label: string;
+      translations: Record<string, string>;
+      attrs?: undefined;
+      badge?: string | {
+        text: string | Record<string, string>;
+        variant: "default" | "success" | "note" | "tip" | "caution" | "danger";
+        class?: string | undefined;
+      } | undefined;
+    } & {
+      items: Array<z.output<z.ZodObject<{
+        link: z.ZodString;
+        attrs: z.ZodDefault<z.ZodType<LinkHTMLAttributes, LinkHTMLAttributes, z.core.$ZodTypeInternals<LinkHTMLAttributes, LinkHTMLAttributes>>>;
+        label: z.ZodString;
+        translations: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+        badge: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+          text: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
+          variant: z.ZodDefault<z.ZodEnum<{
+            default: "default";
+            success: "success";
+            note: "note";
+            tip: "tip";
+            caution: "caution";
+            danger: "danger";
+          }>>;
+          class: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>]>>;
+      }, z.core.$strict>> | z.output<z.ZodObject<{
+        label: z.ZodOptional<z.ZodCustom<never, never>>;
+        autogenerate: z.ZodObject<{
+          directory: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+          collapsed: z.ZodOptional<z.ZodBoolean>;
+          attrs: z.ZodDefault<z.ZodType<LinkHTMLAttributes, LinkHTMLAttributes, z.core.$ZodTypeInternals<LinkHTMLAttributes, LinkHTMLAttributes>>>;
+        }, z.core.$strip>;
+      }, z.core.$strict>> | z.output<z.ZodObject<{
+        slug: z.ZodString;
+        attrs: z.ZodDefault<z.ZodType<LinkHTMLAttributes, LinkHTMLAttributes, z.core.$ZodTypeInternals<LinkHTMLAttributes, LinkHTMLAttributes>>>;
+        label: z.ZodOptional<z.ZodString>;
+        translations: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+        badge: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+          text: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
+          variant: z.ZodDefault<z.ZodEnum<{
+            default: "default";
+            success: "success";
+            note: "note";
+            tip: "tip";
+            caution: "caution";
+            danger: "danger";
+          }>>;
+          class: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>]>>;
+      }, z.core.$strip>> | z.output<z.ZodPipe<z.ZodString, z.ZodTransform<{
+        slug: string;
+        attrs: LinkHTMLAttributes;
+        translations: Record<string, string>;
+        label?: string | undefined;
+        badge?: string | {
+          text: string | Record<string, string>;
+          variant: "default" | "success" | "note" | "tip" | "caution" | "danger";
+          class?: string | undefined;
+        } | undefined;
+      }, string>>> | ({
+        collapsed: boolean;
+        label: string;
+        translations: Record<string, string>;
+        attrs?: undefined;
+        badge?: string | {
+          text: string | Record<string, string>;
+          variant: "default" | "success" | "note" | "tip" | "caution" | "danger";
+          class?: string | undefined;
+        } | undefined;
+      } & /*elided*/ any)>;
+    }) | {
+      slug: string;
+      attrs: LinkHTMLAttributes;
+      translations: Record<string, string>;
+      label?: string | undefined;
+      badge?: string | {
+        text: string | Record<string, string>;
+        variant: "default" | "success" | "note" | "tip" | "caution" | "danger";
+        class?: string | undefined;
+      } | undefined;
+    } | {
+      link: string;
+      attrs: LinkHTMLAttributes;
+      label: string;
+      translations: Record<string, string>;
+      badge?: string | {
+        text: string | Record<string, string>;
+        variant: "default" | "success" | "note" | "tip" | "caution" | "danger";
+        class?: string | undefined;
+      } | undefined;
+    } | {
+      autogenerate: {
+        directory: string;
+        attrs: LinkHTMLAttributes;
+        collapsed?: boolean | undefined;
+      };
+      label?: undefined;
+    })[] | undefined;
+    readonly expressiveCode?: boolean | StarlightExpressiveCodeOptions | undefined;
+  } | {
+    readonly title: Record<string, string>;
+    readonly isMultilingual: false;
+    readonly isUsingBuiltInDefaultLocale: boolean;
+    readonly defaultLocale: {
+      label: string;
+      lang: string;
+      dir: "rtl" | "ltr";
+      locale: undefined;
+    };
+    readonly locales: undefined;
+    readonly pagefind: false | {
+      ranking: {
+        pageLength: number;
+        termFrequency: number;
+        termSaturation: number;
+        termSimilarity: number;
+        diacriticSimilarity: number;
+        metaWeights?: Record<string, number> | undefined;
+      };
+      indexWeight?: number | undefined;
+      mergeIndex?: {
+        bundlePath: string;
+        ranking: {
+          pageLength: number;
+          termFrequency: number;
+          termSaturation: number;
+          termSimilarity: number;
+          diacriticSimilarity: number;
+          metaWeights?: Record<string, number> | undefined;
+        };
+        basePath?: string | undefined;
+        baseUrl?: string | undefined;
+        indexWeight?: number | undefined;
+        mergeFilter?: Record<string, string | [string, ...string[]]> | undefined;
+        language?: string | undefined;
+      }[] | undefined;
+    };
+    readonly tableOfContents: false | {
+      minHeadingLevel: number;
+      maxHeadingLevel: number;
+    } | {
+      minHeadingLevel: number;
+      maxHeadingLevel: number;
+    };
+    readonly editLink: {
+      baseUrl?: string | undefined;
+    };
+    readonly head: {
+      tag: "base" | "link" | "meta" | "noscript" | "script" | "style" | "template" | "title";
+      attrs?: Record<string, string | boolean | undefined> | undefined;
+      content?: string | undefined;
+    }[];
+    readonly customCss: string[];
+    readonly lastUpdated: boolean;
+    readonly pagination: boolean;
+    readonly favicon: {
+      href: string;
+      type: string;
+    };
+    readonly components: {
+      Head: string;
+      ThemeProvider: string;
+      SkipLink: string;
+      PageFrame: string;
+      MobileMenuToggle: string;
+      TwoColumnContent: string;
+      Header: string;
+      SiteTitle: string;
+      Search: string;
+      SocialIcons: string;
+      ThemeSelect: string;
+      LanguageSelect: string;
+      Sidebar: string;
+      MobileMenuFooter: string;
+      PageSidebar: string;
+      TableOfContents: string;
+      MobileTableOfContents: string;
+      Banner: string;
+      ContentPanel: string;
+      PageTitle: string;
+      FallbackContentNotice: string;
+      DraftContentNotice: string;
+      Hero: string;
+      MarkdownContent: string;
+      Footer: string;
+      LastUpdated: string;
+      Pagination: string;
+      EditLink: string;
+    };
+    readonly titleDelimiter: string;
+    readonly disable404Route: boolean;
+    readonly prerender: boolean;
+    readonly credits: boolean;
+    readonly routeMiddleware: string[];
+    readonly markdown: {
+      headingLinks: boolean;
+      processedDirs: string[];
+    };
+    readonly description?: string | undefined;
+    readonly logo?: {
+      src: string;
+      alt: string;
+      replacesTitle: boolean;
+    } | {
+      dark: string;
+      light: string;
+      alt: string;
+      replacesTitle: boolean;
+    } | undefined;
+    readonly social?: {
+      icon: "server" | "external" | "error" | "link" | "up-caret" | "down-caret" | "right-caret" | "left-caret" | "up-arrow" | "down-arrow" | "right-arrow" | "left-arrow" | "bars" | "translate" | "pencil" | "pen" | "document" | "add-document" | "setting" | "link-alt" | "download" | "cloud-download" | "moon" | "sun" | "clock" | "laptop" | "desktop" | "mobile-android" | "window" | "database" | "code-branch" | "open-book" | "notes" | "information" | "magnifier" | "forward-slash" | "close" | "warning" | "approve-check-circle" | "approve-check" | "question-circle" | "question" | "rocket" | "star" | "puzzle" | "list-format" | "analytics" | "random" | "padlock" | "comment" | "comment-alt" | "heart" | "github" | "gitlab" | "bitbucket" | "forgejo" | "codePen" | "farcaster" | "discord" | "gitter" | "twitter" | "x.com" | "mastodon" | "codeberg" | "youtube" | "threads" | "linkedin" | "twitch" | "azureDevOps" | "microsoftTeams" | "instagram" | "stackOverflow" | "telegram" | "whatsApp" | "rss" | "facebook" | "email" | "phone" | "reddit" | "patreon" | "signal" | "slack" | "matrix" | "hackerOne" | "openCollective" | "blueSky" | "discourse" | "zulip" | "pinterest" | "tiktok" | "goodreads" | "hypothesis" | "astro" | "solidjs" | "alpine" | "pnpm" | "biome" | "bun" | "mdx" | "apple" | "linux" | "homebrew" | "nix" | "starlight" | "pkl" | "node" | "cloudflare" | "vercel" | "netlify" | "deno" | "jsr" | "nostr" | "backstage" | "confluence" | "jira" | "storybook" | "vscode" | "jetbrains" | "zed" | "vim" | "figma" | "sketch" | "npm" | "npmx" | "sourcehut" | "substack" | "chrome" | "edge" | "firefox" | "safari" | "seti:folder" | "seti:bsl" | "seti:mdo" | "seti:salesforce" | "seti:asm" | "seti:bicep" | "seti:bazel" | "seti:c" | "seti:c-sharp" | "seti:html" | "seti:cpp" | "seti:clojure" | "seti:coldfusion" | "seti:config" | "seti:crystal" | "seti:crystal_embedded" | "seti:json" | "seti:css" | "seti:csv" | "seti:xls" | "seti:cu" | "seti:cake" | "seti:cake_php" | "seti:d" | "seti:word" | "seti:elixir" | "seti:elixir_script" | "seti:hex" | "seti:elm" | "seti:favicon" | "seti:f-sharp" | "seti:git" | "seti:go" | "seti:godot" | "seti:gradle" | "seti:grails" | "seti:graphql" | "seti:hacklang" | "seti:haml" | "seti:mustache" | "seti:haskell" | "seti:haxe" | "seti:jade" | "seti:java" | "seti:javascript" | "seti:jinja" | "seti:julia" | "seti:karma" | "seti:kotlin" | "seti:dart" | "seti:liquid" | "seti:livescript" | "seti:lua" | "seti:markdown" | "seti:argdown" | "seti:info" | "seti:clock" | "seti:maven" | "seti:nim" | "seti:github" | "seti:notebook" | "seti:nunjucks" | "seti:npm" | "seti:ocaml" | "seti:odata" | "seti:perl" | "seti:php" | "seti:pipeline" | "seti:pddl" | "seti:plan" | "seti:happenings" | "seti:powershell" | "seti:prisma" | "seti:pug" | "seti:puppet" | "seti:purescript" | "seti:python" | "seti:react" | "seti:rescript" | "seti:R" | "seti:ruby" | "seti:rust" | "seti:sass" | "seti:spring" | "seti:slim" | "seti:smarty" | "seti:sbt" | "seti:scala" | "seti:ethereum" | "seti:stylus" | "seti:svelte" | "seti:swift" | "seti:db" | "seti:terraform" | "seti:tex" | "seti:default" | "seti:twig" | "seti:typescript" | "seti:tsconfig" | "seti:vala" | "seti:vite" | "seti:vue" | "seti:wasm" | "seti:wat" | "seti:xml" | "seti:yml" | "seti:prolog" | "seti:zig" | "seti:zip" | "seti:wgt" | "seti:illustrator" | "seti:photoshop" | "seti:pdf" | "seti:font" | "seti:image" | "seti:svg" | "seti:sublime" | "seti:code-search" | "seti:shell" | "seti:video" | "seti:audio" | "seti:windows" | "seti:jenkins" | "seti:babel" | "seti:bower" | "seti:docker" | "seti:code-climate" | "seti:eslint" | "seti:firebase" | "seti:firefox" | "seti:gitlab" | "seti:grunt" | "seti:gulp" | "seti:ionic" | "seti:platformio" | "seti:rollup" | "seti:stylelint" | "seti:yarn" | "seti:webpack" | "seti:lock" | "seti:license" | "seti:makefile" | "seti:heroku" | "seti:todo" | "seti:ignored";
+      label: string;
+      href: string;
+    }[] | undefined;
+    readonly sidebar?: (({
+      collapsed: boolean;
+      label: string;
+      translations: Record<string, string>;
+      attrs?: undefined;
+      badge?: string | {
+        text: string | Record<string, string>;
+        variant: "default" | "success" | "note" | "tip" | "caution" | "danger";
+        class?: string | undefined;
+      } | undefined;
+    } & {
+      items: Array<z.output<z.ZodObject<{
+        link: z.ZodString;
+        attrs: z.ZodDefault<z.ZodType<LinkHTMLAttributes, LinkHTMLAttributes, z.core.$ZodTypeInternals<LinkHTMLAttributes, LinkHTMLAttributes>>>;
+        label: z.ZodString;
+        translations: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+        badge: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+          text: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
+          variant: z.ZodDefault<z.ZodEnum<{
+            default: "default";
+            success: "success";
+            note: "note";
+            tip: "tip";
+            caution: "caution";
+            danger: "danger";
+          }>>;
+          class: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>]>>;
+      }, z.core.$strict>> | z.output<z.ZodObject<{
+        label: z.ZodOptional<z.ZodCustom<never, never>>;
+        autogenerate: z.ZodObject<{
+          directory: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+          collapsed: z.ZodOptional<z.ZodBoolean>;
+          attrs: z.ZodDefault<z.ZodType<LinkHTMLAttributes, LinkHTMLAttributes, z.core.$ZodTypeInternals<LinkHTMLAttributes, LinkHTMLAttributes>>>;
+        }, z.core.$strip>;
+      }, z.core.$strict>> | z.output<z.ZodObject<{
+        slug: z.ZodString;
+        attrs: z.ZodDefault<z.ZodType<LinkHTMLAttributes, LinkHTMLAttributes, z.core.$ZodTypeInternals<LinkHTMLAttributes, LinkHTMLAttributes>>>;
+        label: z.ZodOptional<z.ZodString>;
+        translations: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodString>>;
+        badge: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+          text: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>]>;
+          variant: z.ZodDefault<z.ZodEnum<{
+            default: "default";
+            success: "success";
+            note: "note";
+            tip: "tip";
+            caution: "caution";
+            danger: "danger";
+          }>>;
+          class: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>]>>;
+      }, z.core.$strip>> | z.output<z.ZodPipe<z.ZodString, z.ZodTransform<{
+        slug: string;
+        attrs: LinkHTMLAttributes;
+        translations: Record<string, string>;
+        label?: string | undefined;
+        badge?: string | {
+          text: string | Record<string, string>;
+          variant: "default" | "success" | "note" | "tip" | "caution" | "danger";
+          class?: string | undefined;
+        } | undefined;
+      }, string>>> | ({
+        collapsed: boolean;
+        label: string;
+        translations: Record<string, string>;
+        attrs?: undefined;
+        badge?: string | {
+          text: string | Record<string, string>;
+          variant: "default" | "success" | "note" | "tip" | "caution" | "danger";
+          class?: string | undefined;
+        } | undefined;
+      } & /*elided*/ any)>;
+    }) | {
+      slug: string;
+      attrs: LinkHTMLAttributes;
+      translations: Record<string, string>;
+      label?: string | undefined;
+      badge?: string | {
+        text: string | Record<string, string>;
+        variant: "default" | "success" | "note" | "tip" | "caution" | "danger";
+        class?: string | undefined;
+      } | undefined;
+    } | {
+      link: string;
+      attrs: LinkHTMLAttributes;
+      label: string;
+      translations: Record<string, string>;
+      badge?: string | {
+        text: string | Record<string, string>;
+        variant: "default" | "success" | "note" | "tip" | "caution" | "danger";
+        class?: string | undefined;
+      } | undefined;
+    } | {
+      autogenerate: {
+        directory: string;
+        attrs: LinkHTMLAttributes;
+        collapsed?: boolean | undefined;
+      };
+      label?: undefined;
+    })[] | undefined;
+    readonly expressiveCode?: boolean | StarlightExpressiveCodeOptions | undefined;
+  };
+  pluginTranslations: PluginTranslations;
+  useTranslations: (lang: string | undefined) => I18nT;
+  absolutePathToLang: (path: string) => string;
+}>;
+declare function injectPluginTranslationsTypes(translations: PluginTranslations, injectTypes: HookParameters$1<'astro:config:done'>['injectTypes']): void;
+interface RouteMiddlewareUserConfig {
+  entrypoint: string;
+  order?: 'pre' | 'post' | 'default' | undefined;
+}
+interface BaseStarlightPluginUserConfig {
+  /** Name of the Starlight plugin. */
+  name: string;
+}
+type StarlightI18nTFactory = Awaited<ReturnType<typeof createTranslationSystemFromFs>>;
+type ConfigSetupHookUserConfig = ((options: {
+  /**
+   * A read-only copy of the user-supplied Starlight configuration.
+   *
+   * Note that this configuration may have been updated by other plugins configured
+   * before this one.
+   */
+  config: StarlightUserConfig & {
+    plugins?: StarlightPluginUserConfig[] | undefined;
+  };
+  /**
+   * A callback function to update the user-supplied Starlight configuration.
+   *
+   * You only need to provide the configuration values that you want to update but no deep
+   * merge is performed.
+   *
+   * @example
+   * {
+   * 	name: 'My Starlight Plugin',
+   *	hooks: {
+   * 		'config:setup'({ updateConfig }) {
+   * 			updateConfig({
+   * 				description: 'Custom description',
+   * 			});
+   * 		}
+   *	}
+   * }
+   */
+  updateConfig: (newConfig: Partial<Omit<StarlightUserConfig, 'routeMiddleware'>>) => void;
+  /**
+   * A callback function to add an Astro integration required by this plugin.
+   *
+   * @see https://docs.astro.build/en/reference/integrations-reference/
+   *
+   * @example
+   * {
+   * 	name: 'My Starlight Plugin',
+   * 	hooks: {
+   * 		'config:setup'({ addIntegration }) {
+   * 			addIntegration({
+   * 				name: 'My Plugin Astro Integration',
+   * 				hooks: {
+   * 					'astro:config:setup': () => {
+   * 						// …
+   * 					},
+   * 				},
+   * 			});
+   * 		}
+   * 	}
+   * }
+   */
+  addIntegration: (integration: AstroIntegration) => void;
+  /**
+   * A callback function to register additional route middleware handlers.
+   *
+   * If the order of execution is important, a plugin can use the `order` option to enforce
+   * running first or last.
+   *
+   * @example
+   * {
+   * 	name: 'My Starlight Plugin',
+   * 	hooks: {
+   * 		setup({ addRouteMiddleware }) {
+   * 			addRouteMiddleware({ entrypoint: '@me/my-plugin/route-middleware' });
+   * 		},
+   * 	},
+   * }
+   */
+  addRouteMiddleware: (config: RouteMiddlewareUserConfig) => void;
+  /**
+   * A read-only copy of the user-supplied Astro configuration.
+   *
+   * Note that this configuration is resolved before any other integrations have run.
+   *
+   * @see https://docs.astro.build/en/reference/integrations-reference/#config-option
+   */
+  astroConfig: StarlightPluginContext['config'];
+  /**
+   * The command used to run Starlight.
+   *
+   * @see https://docs.astro.build/en/reference/integrations-reference/#command-option
+   */
+  command: StarlightPluginContext['command'];
+  /**
+   * `false` when the dev server starts, `true` when a reload is triggered.
+   *
+   * @see https://docs.astro.build/en/reference/integrations-reference/#isrestart-option
+   */
+  isRestart: StarlightPluginContext['isRestart'];
+  /**
+   * An instance of the Astro integration logger with all logged messages prefixed with the
+   * plugin name.
+   *
+   * @see https://docs.astro.build/en/reference/integrations-reference/#astrointegrationlogger
+   */
+  logger: StarlightPluginContext['logger'];
+  /**
+   * A callback function to generate a utility function to access UI strings for a given
+   * language.
+   *
+   * @see https://starlight.astro.build/guides/i18n/#using-ui-translations
+   *
+   * @example
+   * {
+   * 	name: 'My Starlight Plugin',
+   *	hooks: {
+   * 		'config:setup'({ useTranslations, logger }) {
+   * 			const t = useTranslations('en');
+   * 			logger.info(t('builtWithStarlight.label'));
+   * 		  // ^ Logs 'Built with Starlight' to the console.
+   * 		}
+   *	}
+   * }
+   */
+  useTranslations: Awaited<ReturnType<typeof createTranslationSystemFromFs>>;
+  /**
+   * A callback function to get the language for a given absolute file path. The returned
+   * language can be used with the `useTranslations` helper to get UI strings for that
+   * language.
+   *
+   * This can be particularly useful in remark or rehype plugins to get the language for
+   * the current file being processed and use it to get the appropriate UI strings for that
+   * language.
+   *
+   * @example
+   * {
+   * 	name: 'My Starlight Plugin',
+   *	hooks: {
+   * 		'config:setup'({ absolutePathToLang, useTranslations, logger }) {
+   * 			const lang = absolutePathToLang('/absolute/path/to/project/src/content/docs/fr/index.mdx');
+   * 			const t = useTranslations(lang);
+   * 			logger.info(t('aside.tip'));
+   * 		  // ^ Logs 'Astuce' to the console.
+   * 		}
+   *	}
+   * }
+   */
+  absolutePathToLang: (path: string) => string;
+}) => void | Promise<void>) | undefined;
+interface StarlightPluginUserConfig extends BaseStarlightPluginUserConfig {
+  /** The different hooks available to the plugin. */
+  hooks: {
+    'i18n:setup'?: ((options: {
+      /**
+       * A callback function to add or update translations strings.
+       *
+       * @see https://starlight.astro.build/guides/i18n/#extend-translation-schema
+       *
+       * @example
+       * {
+       * 	name: 'My Starlight Plugin',
+       * 	hooks: {
+       * 		'i18n:setup'({ injectTranslations }) {
+       * 			injectTranslations({
+       * 				en: {
+       * 					'myPlugin.doThing': 'Do the thing',
+       * 				},
+       * 				fr: {
+       * 					'myPlugin.doThing': 'Faire le truc',
+       * 				},
+       * 			});
+       * 		}
+       * 	}
+       * }
+       */
+      injectTranslations: (translations: Record<string, Record<string, string>>) => void;
+    }) => void | Promise<void>) | undefined;
+    /**
+     * Plugin configuration setup function called with an object containing various values that
+     * can be used by the plugin to interact with Starlight.
+     */
+    'config:setup'?: ConfigSetupHookUserConfig;
+    /**
+     * @deprecated Use the `config:setup` hook instead as `setup` will be removed in a future
+     * version.
+     */
+    setup?: ConfigSetupHookUserConfig;
+  };
+}
+type StarlightPluginsUserConfig = StarlightPluginUserConfig[] | undefined;
+declare const StarlightPluginsConfigSchema: z.ZodDefault<z.ZodArray<z.ZodObject<{
+  hooks: z.ZodObject<{
+    'i18n:setup': z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
+      injectTranslations: z.ZodFunction<z.ZodTuple<readonly [z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodString>>], null>, z.ZodVoid>;
+    }, z.core.$strip>], null>, z.ZodPromise<z.ZodVoid>>>;
+    'config:setup': z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
+      config: z.ZodType<StarlightUserConfigWithPlugins, StarlightUserConfigWithPlugins>;
+      updateConfig: z.ZodFunction<z.ZodTuple<readonly [z.ZodType<Partial<Omit<StarlightUserConfig, "routeMiddleware">>, Partial<Omit<StarlightUserConfig, "routeMiddleware">>, z.core.$ZodTypeInternals<Partial<Omit<StarlightUserConfig, "routeMiddleware">>, Partial<Omit<StarlightUserConfig, "routeMiddleware">>>>], null>, z.ZodVoid>;
+      addIntegration: z.ZodFunction<z.ZodTuple<readonly [z.ZodType<AstroIntegration, AstroIntegration, z.core.$ZodTypeInternals<AstroIntegration, AstroIntegration>>], null>, z.ZodVoid>;
+      addRouteMiddleware: z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
+        entrypoint: z.ZodString;
+        order: z.ZodDefault<z.ZodEnum<{
+          default: "default";
+          pre: "pre";
+          post: "post";
+        }>>;
+      }, z.core.$strip>], null>, z.ZodVoid>;
+      astroConfig: z.ZodType<StarlightPluginContext["config"], StarlightPluginContext["config"]>;
+      command: z.ZodType<StarlightPluginContext["command"], StarlightPluginContext["command"]>;
+      isRestart: z.ZodType<StarlightPluginContext["isRestart"], StarlightPluginContext["isRestart"]>;
+      logger: z.ZodType<StarlightPluginContext["logger"], StarlightPluginContext["logger"]>;
+      useTranslations: z.ZodType<StarlightI18nTFactory, StarlightI18nTFactory>;
+      absolutePathToLang: z.ZodFunction<z.ZodTuple<readonly [z.ZodString], null>, z.ZodString>;
+    }, z.core.$strip>], null>, z.ZodPromise<z.ZodVoid>>>;
+    setup: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
+      config: z.ZodType<StarlightUserConfigWithPlugins, StarlightUserConfigWithPlugins>;
+      updateConfig: z.ZodFunction<z.ZodTuple<readonly [z.ZodType<Partial<Omit<StarlightUserConfig, "routeMiddleware">>, Partial<Omit<StarlightUserConfig, "routeMiddleware">>, z.core.$ZodTypeInternals<Partial<Omit<StarlightUserConfig, "routeMiddleware">>, Partial<Omit<StarlightUserConfig, "routeMiddleware">>>>], null>, z.ZodVoid>;
+      addIntegration: z.ZodFunction<z.ZodTuple<readonly [z.ZodType<AstroIntegration, AstroIntegration, z.core.$ZodTypeInternals<AstroIntegration, AstroIntegration>>], null>, z.ZodVoid>;
+      addRouteMiddleware: z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
+        entrypoint: z.ZodString;
+        order: z.ZodDefault<z.ZodEnum<{
+          default: "default";
+          pre: "pre";
+          post: "post";
+        }>>;
+      }, z.core.$strip>], null>, z.ZodVoid>;
+      astroConfig: z.ZodType<StarlightPluginContext["config"], StarlightPluginContext["config"]>;
+      command: z.ZodType<StarlightPluginContext["command"], StarlightPluginContext["command"]>;
+      isRestart: z.ZodType<StarlightPluginContext["isRestart"], StarlightPluginContext["isRestart"]>;
+      logger: z.ZodType<StarlightPluginContext["logger"], StarlightPluginContext["logger"]>;
+      useTranslations: z.ZodType<StarlightI18nTFactory, StarlightI18nTFactory>;
+      absolutePathToLang: z.ZodFunction<z.ZodTuple<readonly [z.ZodString], null>, z.ZodString>;
+    }, z.core.$strip>], null>, z.ZodPromise<z.ZodVoid>>>;
+  }, z.core.$strip>;
+  name: z.ZodString;
+}, z.core.$strip>>>;
+type StarlightPlugin = StarlightPluginUserConfig;
+type HookParameters<Hook extends keyof StarlightPlugin['hooks'], HookFn = StarlightPlugin['hooks'][Hook]> = HookFn extends ((...args: any[]) => unknown) ? Parameters<HookFn>[0] : never;
+type StarlightUserConfigWithPlugins = StarlightUserConfig & {
+  /**
+   * A list of plugins to extend Starlight with.
+   *
+   * @example
+   * // Add Starlight Algolia plugin.
+   * starlight({
+   * 	plugins: [starlightAlgolia({ … })],
+   * })
+   */
+  plugins?: StarlightPluginsUserConfig;
+};
+type StarlightPluginContext = Pick<HookParameters$1<'astro:config:setup'>, 'command' | 'config' | 'isRestart' | 'logger'>;
+type PluginTranslations = Record<string, UserI18nSchema & Record<string, string>>;
+//#endregion
+export { HookParameters, PluginTranslations, StarlightPlugin, StarlightPluginContext, StarlightPluginsConfigSchema, StarlightUserConfigWithPlugins, injectPluginTranslationsTypes, runPlugins };