@astrojs/starlight 0.41.11 → 0.42.0

package/dist/schemas/icon.d.ts

@@ -0,0 +1,284 @@
+import { StarlightIcon } from "../components-internals/Icons.js";
+import { z } from "astro/zod";
+//#region src/schemas/icon.d.ts
+/** String that matches the name of one of Starlight’s built-in icons. */
+type IconUserConfig = StarlightIcon;
+declare const IconSchema: () => z.ZodEnum<{
+  server: "server";
+  external: "external";
+  error: "error";
+  link: "link";
+  "up-caret": "up-caret";
+  "down-caret": "down-caret";
+  "right-caret": "right-caret";
+  "left-caret": "left-caret";
+  "up-arrow": "up-arrow";
+  "down-arrow": "down-arrow";
+  "right-arrow": "right-arrow";
+  "left-arrow": "left-arrow";
+  bars: "bars";
+  translate: "translate";
+  pencil: "pencil";
+  pen: "pen";
+  document: "document";
+  "add-document": "add-document";
+  setting: "setting";
+  "link-alt": "link-alt";
+  download: "download";
+  "cloud-download": "cloud-download";
+  moon: "moon";
+  sun: "sun";
+  clock: "clock";
+  laptop: "laptop";
+  desktop: "desktop";
+  "mobile-android": "mobile-android";
+  window: "window";
+  database: "database";
+  "code-branch": "code-branch";
+  "open-book": "open-book";
+  notes: "notes";
+  information: "information";
+  magnifier: "magnifier";
+  "forward-slash": "forward-slash";
+  close: "close";
+  warning: "warning";
+  "approve-check-circle": "approve-check-circle";
+  "approve-check": "approve-check";
+  "question-circle": "question-circle";
+  question: "question";
+  rocket: "rocket";
+  star: "star";
+  puzzle: "puzzle";
+  "list-format": "list-format";
+  analytics: "analytics";
+  random: "random";
+  padlock: "padlock";
+  comment: "comment";
+  "comment-alt": "comment-alt";
+  heart: "heart";
+  github: "github";
+  gitlab: "gitlab";
+  bitbucket: "bitbucket";
+  forgejo: "forgejo";
+  codePen: "codePen";
+  farcaster: "farcaster";
+  discord: "discord";
+  gitter: "gitter";
+  twitter: "twitter";
+  "x.com": "x.com";
+  mastodon: "mastodon";
+  codeberg: "codeberg";
+  youtube: "youtube";
+  threads: "threads";
+  linkedin: "linkedin";
+  twitch: "twitch";
+  azureDevOps: "azureDevOps";
+  microsoftTeams: "microsoftTeams";
+  instagram: "instagram";
+  stackOverflow: "stackOverflow";
+  telegram: "telegram";
+  whatsApp: "whatsApp";
+  rss: "rss";
+  facebook: "facebook";
+  email: "email";
+  phone: "phone";
+  reddit: "reddit";
+  patreon: "patreon";
+  signal: "signal";
+  slack: "slack";
+  matrix: "matrix";
+  hackerOne: "hackerOne";
+  openCollective: "openCollective";
+  blueSky: "blueSky";
+  discourse: "discourse";
+  zulip: "zulip";
+  pinterest: "pinterest";
+  tiktok: "tiktok";
+  goodreads: "goodreads";
+  hypothesis: "hypothesis";
+  astro: "astro";
+  solidjs: "solidjs";
+  alpine: "alpine";
+  pnpm: "pnpm";
+  biome: "biome";
+  bun: "bun";
+  mdx: "mdx";
+  apple: "apple";
+  linux: "linux";
+  homebrew: "homebrew";
+  nix: "nix";
+  starlight: "starlight";
+  pkl: "pkl";
+  node: "node";
+  cloudflare: "cloudflare";
+  vercel: "vercel";
+  netlify: "netlify";
+  deno: "deno";
+  jsr: "jsr";
+  nostr: "nostr";
+  backstage: "backstage";
+  confluence: "confluence";
+  jira: "jira";
+  storybook: "storybook";
+  vscode: "vscode";
+  jetbrains: "jetbrains";
+  zed: "zed";
+  vim: "vim";
+  figma: "figma";
+  sketch: "sketch";
+  npm: "npm";
+  npmx: "npmx";
+  sourcehut: "sourcehut";
+  substack: "substack";
+  chrome: "chrome";
+  edge: "edge";
+  firefox: "firefox";
+  safari: "safari";
+  "seti:folder": "seti:folder";
+  "seti:bsl": "seti:bsl";
+  "seti:mdo": "seti:mdo";
+  "seti:salesforce": "seti:salesforce";
+  "seti:asm": "seti:asm";
+  "seti:bicep": "seti:bicep";
+  "seti:bazel": "seti:bazel";
+  "seti:c": "seti:c";
+  "seti:c-sharp": "seti:c-sharp";
+  "seti:html": "seti:html";
+  "seti:cpp": "seti:cpp";
+  "seti:clojure": "seti:clojure";
+  "seti:coldfusion": "seti:coldfusion";
+  "seti:config": "seti:config";
+  "seti:crystal": "seti:crystal";
+  "seti:crystal_embedded": "seti:crystal_embedded";
+  "seti:json": "seti:json";
+  "seti:css": "seti:css";
+  "seti:csv": "seti:csv";
+  "seti:xls": "seti:xls";
+  "seti:cu": "seti:cu";
+  "seti:cake": "seti:cake";
+  "seti:cake_php": "seti:cake_php";
+  "seti:d": "seti:d";
+  "seti:word": "seti:word";
+  "seti:elixir": "seti:elixir";
+  "seti:elixir_script": "seti:elixir_script";
+  "seti:hex": "seti:hex";
+  "seti:elm": "seti:elm";
+  "seti:favicon": "seti:favicon";
+  "seti:f-sharp": "seti:f-sharp";
+  "seti:git": "seti:git";
+  "seti:go": "seti:go";
+  "seti:godot": "seti:godot";
+  "seti:gradle": "seti:gradle";
+  "seti:grails": "seti:grails";
+  "seti:graphql": "seti:graphql";
+  "seti:hacklang": "seti:hacklang";
+  "seti:haml": "seti:haml";
+  "seti:mustache": "seti:mustache";
+  "seti:haskell": "seti:haskell";
+  "seti:haxe": "seti:haxe";
+  "seti:jade": "seti:jade";
+  "seti:java": "seti:java";
+  "seti:javascript": "seti:javascript";
+  "seti:jinja": "seti:jinja";
+  "seti:julia": "seti:julia";
+  "seti:karma": "seti:karma";
+  "seti:kotlin": "seti:kotlin";
+  "seti:dart": "seti:dart";
+  "seti:liquid": "seti:liquid";
+  "seti:livescript": "seti:livescript";
+  "seti:lua": "seti:lua";
+  "seti:markdown": "seti:markdown";
+  "seti:argdown": "seti:argdown";
+  "seti:info": "seti:info";
+  "seti:clock": "seti:clock";
+  "seti:maven": "seti:maven";
+  "seti:nim": "seti:nim";
+  "seti:github": "seti:github";
+  "seti:notebook": "seti:notebook";
+  "seti:nunjucks": "seti:nunjucks";
+  "seti:npm": "seti:npm";
+  "seti:ocaml": "seti:ocaml";
+  "seti:odata": "seti:odata";
+  "seti:perl": "seti:perl";
+  "seti:php": "seti:php";
+  "seti:pipeline": "seti:pipeline";
+  "seti:pddl": "seti:pddl";
+  "seti:plan": "seti:plan";
+  "seti:happenings": "seti:happenings";
+  "seti:powershell": "seti:powershell";
+  "seti:prisma": "seti:prisma";
+  "seti:pug": "seti:pug";
+  "seti:puppet": "seti:puppet";
+  "seti:purescript": "seti:purescript";
+  "seti:python": "seti:python";
+  "seti:react": "seti:react";
+  "seti:rescript": "seti:rescript";
+  "seti:R": "seti:R";
+  "seti:ruby": "seti:ruby";
+  "seti:rust": "seti:rust";
+  "seti:sass": "seti:sass";
+  "seti:spring": "seti:spring";
+  "seti:slim": "seti:slim";
+  "seti:smarty": "seti:smarty";
+  "seti:sbt": "seti:sbt";
+  "seti:scala": "seti:scala";
+  "seti:ethereum": "seti:ethereum";
+  "seti:stylus": "seti:stylus";
+  "seti:svelte": "seti:svelte";
+  "seti:swift": "seti:swift";
+  "seti:db": "seti:db";
+  "seti:terraform": "seti:terraform";
+  "seti:tex": "seti:tex";
+  "seti:default": "seti:default";
+  "seti:twig": "seti:twig";
+  "seti:typescript": "seti:typescript";
+  "seti:tsconfig": "seti:tsconfig";
+  "seti:vala": "seti:vala";
+  "seti:vite": "seti:vite";
+  "seti:vue": "seti:vue";
+  "seti:wasm": "seti:wasm";
+  "seti:wat": "seti:wat";
+  "seti:xml": "seti:xml";
+  "seti:yml": "seti:yml";
+  "seti:prolog": "seti:prolog";
+  "seti:zig": "seti:zig";
+  "seti:zip": "seti:zip";
+  "seti:wgt": "seti:wgt";
+  "seti:illustrator": "seti:illustrator";
+  "seti:photoshop": "seti:photoshop";
+  "seti:pdf": "seti:pdf";
+  "seti:font": "seti:font";
+  "seti:image": "seti:image";
+  "seti:svg": "seti:svg";
+  "seti:sublime": "seti:sublime";
+  "seti:code-search": "seti:code-search";
+  "seti:shell": "seti:shell";
+  "seti:video": "seti:video";
+  "seti:audio": "seti:audio";
+  "seti:windows": "seti:windows";
+  "seti:jenkins": "seti:jenkins";
+  "seti:babel": "seti:babel";
+  "seti:bower": "seti:bower";
+  "seti:docker": "seti:docker";
+  "seti:code-climate": "seti:code-climate";
+  "seti:eslint": "seti:eslint";
+  "seti:firebase": "seti:firebase";
+  "seti:firefox": "seti:firefox";
+  "seti:gitlab": "seti:gitlab";
+  "seti:grunt": "seti:grunt";
+  "seti:gulp": "seti:gulp";
+  "seti:ionic": "seti:ionic";
+  "seti:platformio": "seti:platformio";
+  "seti:rollup": "seti:rollup";
+  "seti:stylelint": "seti:stylelint";
+  "seti:yarn": "seti:yarn";
+  "seti:webpack": "seti:webpack";
+  "seti:lock": "seti:lock";
+  "seti:license": "seti:license";
+  "seti:makefile": "seti:makefile";
+  "seti:heroku": "seti:heroku";
+  "seti:todo": "seti:todo";
+  "seti:ignored": "seti:ignored";
+}>;
+//#endregion
+export { IconSchema, IconUserConfig };

package/dist/schemas/icon.js

@@ -0,0 +1,7 @@
+import { Icons } from "../components-internals/Icons.js";
+import { z } from "astro/zod";
+//#region src/schemas/icon.ts
+const iconNames = Object.keys(Icons);
+const IconSchema = () => z.enum(iconNames);
+//#endregion
+export { IconSchema };

package/dist/schemas/locale.d.ts

@@ -0,0 +1,20 @@
+import { z } from "astro/zod";
+//#region src/schemas/locale.d.ts
+interface LocaleUserConfig {
+  /** The label for this language to show in UI, e.g. `"English"`, `"العربية"`, or `"简体中文"`. */
+  label: string;
+  /** The BCP-47 tag for this language, e.g. `"en"`, `"ar"`, or `"zh-CN"`. */
+  lang?: string | undefined;
+  /** The writing direction of this language; `"ltr"` for left-to-right (the default) or `"rtl"` for right-to-left. */
+  dir?: 'rtl' | 'ltr' | undefined;
+}
+declare function LocaleConfigSchema(): z.ZodObject<{
+  label: z.ZodString;
+  lang: z.ZodOptional<z.ZodString>;
+  dir: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+    rtl: "rtl";
+    ltr: "ltr";
+  }>>>;
+}, z.core.$strip>;
+//#endregion
+export { LocaleConfigSchema, LocaleUserConfig };

package/dist/schemas/locale.js

@@ -0,0 +1,11 @@
+import { z } from "astro/zod";
+//#region src/schemas/locale.ts
+function LocaleConfigSchema() {
+	return z.object({
+		label: z.string(),
+		lang: z.string().optional(),
+		dir: z.enum(["rtl", "ltr"]).optional().default("ltr")
+	});
+}
+//#endregion
+export { LocaleConfigSchema };

package/dist/schemas/logo.d.ts

@@ -0,0 +1,32 @@
+import { z } from "astro/zod";
+//#region src/schemas/logo.d.ts
+type LogoUserConfig = {
+  /** Source of the image file to use. */
+  src: string;
+  /** Alternative text description of the logo. */
+  alt?: string | undefined;
+  /** Set to `true` to hide the site title text and only show the logo. */
+  replacesTitle?: boolean | undefined;
+} | {
+  /** Source of the image file to use in dark mode. */
+  dark: string;
+  /** Source of the image file to use in light mode. */
+  light: string;
+  /** Alternative text description of the logo. */
+  alt?: string | undefined;
+  /** Set to `true` to hide the site title text and only show the logo. */
+  replacesTitle?: boolean | undefined;
+} | undefined;
+declare const LogoConfigSchema: () => z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+  src: z.ZodString;
+  alt: z.ZodDefault<z.ZodString>;
+  replacesTitle: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>, z.ZodObject<{
+  dark: z.ZodString;
+  light: z.ZodString;
+  alt: z.ZodDefault<z.ZodString>;
+  replacesTitle: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strip>]>>;
+type LogoConfig = z.output<ReturnType<typeof LogoConfigSchema>>;
+//#endregion
+export { LogoConfig, LogoConfigSchema, LogoUserConfig };

package/dist/schemas/logo.js

@@ -0,0 +1,14 @@
+import { z } from "astro/zod";
+//#region src/schemas/logo.ts
+const LogoConfigSchema = () => z.union([z.object({
+	src: z.string(),
+	alt: z.string().default(""),
+	replacesTitle: z.boolean().default(false)
+}), z.object({
+	dark: z.string(),
+	light: z.string(),
+	alt: z.string().default(""),
+	replacesTitle: z.boolean().default(false)
+})]).optional();
+//#endregion
+export { LogoConfigSchema };

package/dist/schemas/pagefind.d.ts

@@ -0,0 +1,166 @@
+import { z } from "astro/zod";
+//#region src/schemas/pagefind.d.ts
+interface PagefindUserConfig {
+  /**
+   * Configure how search results from the current website are weighted by Pagefind
+   * compared to results from other sites when using the `mergeIndex` option.
+   *
+   * @see https://pagefind.app/docs/multisite/#changing-the-weighting-of-individual-indexes
+   */
+  indexWeight?: number | undefined;
+  /** Configure how search result rankings are calculated by Pagefind. */
+  ranking?: PagefindRankingUserConfig | undefined;
+  /**
+   * Configure how search indexes from different sites are merged by Pagefind.
+   * Each entry of this array represents a `PagefindIndexOptions` from pagefind.
+   *
+   * @see https://pagefind.app/docs/multisite/#searching-additional-sites-from-pagefind-ui
+   * @see https://github.com/CloudCannon/pagefind/blob/v1.3.0/pagefind_web_js/lib/coupled_search.ts#L549
+   */
+  mergeIndex?: {
+    /**
+     * Set Pagefind’s `bundlePath` mergeIndex option.
+     *
+     * @see https://pagefind.app/docs/multisite/#searching-additional-sites-from-pagefind-ui
+     */
+    bundlePath: string;
+    /**
+     * Overrides the URL path that Pagefind uses to load its search bundle
+     */
+    basePath?: string | undefined;
+    /**
+     * Appends the given baseURL to all search results. May be a path, or a full domain
+     */
+    baseUrl?: string | undefined;
+    /**
+     * Multiply all rankings for this index by the given weight.
+     *
+     * @see https://pagefind.app/docs/multisite/#changing-the-weighting-of-individual-indexes
+     */
+    indexWeight?: number | undefined;
+    /**
+     * Apply this filter configuration to all search results from this index.
+     *
+     * Only applies in multisite setups.
+     *
+     * @see https://pagefind.app/docs/multisite/#filtering-results-by-index
+     */
+    mergeFilter?: Record<string, string | [string, ...string[]]> | undefined;
+    /**
+     * Language of this index.
+     *
+     * @see https://pagefind.app/docs/multisite/#merging-a-specific-language-index
+     */
+    language?: string | undefined;
+    /**
+     * Configure how search result rankings are calculated by Pagefind.
+     */
+    ranking?: PagefindRankingUserConfig | undefined;
+  }[] | undefined;
+}
+interface PagefindRankingUserConfig {
+  /**
+   * Set Pagefind’s `pageLength` ranking option.
+   *
+   * The default value is `0.1` and values must be in the range `0` to `1`.
+   *
+   * @see https://pagefind.app/docs/ranking/#configuring-page-length
+   */
+  pageLength?: number | undefined;
+  /**
+   * Set Pagefind’s `termFrequency` ranking option.
+   *
+   * The default value is `0.1` and values must be in the range `0` to `1`.
+   *
+   * @see https://pagefind.app/docs/ranking/#configuring-term-frequency
+   */
+  termFrequency?: number | undefined;
+  /**
+   * Set Pagefind’s `termSaturation` ranking option.
+   *
+   * The default value is `2` and values must be in the range `0` to `2`.
+   *
+   * @see https://pagefind.app/docs/ranking/#configuring-term-saturation
+   */
+  termSaturation?: number | undefined;
+  /**
+   * Set Pagefind’s `termSimilarity` ranking option.
+   *
+   * The default value is `9` and values must be greater than or equal to `0`.
+   *
+   * @see https://pagefind.app/docs/ranking/#configuring-term-similarity
+   */
+  termSimilarity?: number | undefined;
+  /**
+   * Set Pagefind’s `diacriticSimilarity` ranking option.
+   *
+   * The default value is `0.8` and values must be greater than or equal to `0`.
+   *
+   * @see https://pagefind.app/docs/ranking/#configuring-diacritic-similarity
+   */
+  diacriticSimilarity?: number | undefined;
+  /**
+   * Set Pagefind’s `metaWeights` ranking option.
+   *
+   * This is a map of metadata keys to their corresponding weights, with a default value of `{ title: 5 }`.
+   *
+   * @see https://pagefind.app/docs/ranking/#configuring-metadata-weights
+   */
+  metaWeights?: Record<string, number> | undefined;
+}
+declare const PagefindConfigSchema: () => z.ZodObject<{
+  indexWeight: z.ZodOptional<z.ZodNumber>;
+  ranking: z.ZodPrefault<z.ZodObject<{
+    pageLength: z.ZodDefault<z.ZodNumber>;
+    termFrequency: z.ZodDefault<z.ZodNumber>;
+    termSaturation: z.ZodDefault<z.ZodNumber>;
+    termSimilarity: z.ZodDefault<z.ZodNumber>;
+    diacriticSimilarity: z.ZodDefault<z.ZodNumber>;
+    metaWeights: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+  }, z.core.$strip>>;
+  mergeIndex: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    bundlePath: z.ZodString;
+    basePath: z.ZodOptional<z.ZodString>;
+    baseUrl: z.ZodOptional<z.ZodString>;
+    indexWeight: z.ZodOptional<z.ZodNumber>;
+    mergeFilter: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodTuple<[z.ZodString], z.ZodString>]>>>;
+    language: z.ZodOptional<z.ZodString>;
+    ranking: z.ZodPrefault<z.ZodObject<{
+      pageLength: z.ZodDefault<z.ZodNumber>;
+      termFrequency: z.ZodDefault<z.ZodNumber>;
+      termSaturation: z.ZodDefault<z.ZodNumber>;
+      termSimilarity: z.ZodDefault<z.ZodNumber>;
+      diacriticSimilarity: z.ZodDefault<z.ZodNumber>;
+      metaWeights: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
+    }, z.core.$strip>>;
+  }, z.core.$strip>>>;
+}, z.core.$strip>;
+declare const PagefindConfigDefaults: () => {
+  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;
+};
+//#endregion
+export { PagefindConfigDefaults, PagefindConfigSchema, PagefindUserConfig };

package/dist/schemas/pagefind.js

@@ -0,0 +1,31 @@
+import { z } from "astro/zod";
+//#region src/schemas/pagefind.ts
+const indexWeightSchema = z.number().nonnegative().optional();
+const pagefindRankingWeightsSchema = z.object({
+	pageLength: z.number().min(0).max(1).default(.1),
+	termFrequency: z.number().min(0).max(1).default(.1),
+	termSaturation: z.number().min(0).max(2).default(2),
+	termSimilarity: z.number().min(0).default(9),
+	diacriticSimilarity: z.number().min(0).default(.8),
+	metaWeights: z.record(z.string(), z.number().min(0)).optional()
+});
+const pagefindIndexOptionsSchema = z.object({
+	basePath: z.string().optional(),
+	baseUrl: z.string().optional(),
+	indexWeight: indexWeightSchema,
+	mergeFilter: z.record(z.string(), z.string().or(z.tuple([z.string()], z.string()))).optional(),
+	language: z.string().optional(),
+	ranking: pagefindRankingWeightsSchema.prefault({})
+});
+const pagefindSchema = z.object({
+	indexWeight: indexWeightSchema,
+	ranking: pagefindRankingWeightsSchema.prefault({}),
+	mergeIndex: z.array(z.object({
+		...pagefindIndexOptionsSchema.shape,
+		bundlePath: z.string()
+	})).optional()
+});
+const PagefindConfigSchema = () => pagefindSchema;
+const PagefindConfigDefaults = () => pagefindSchema.parse({});
+//#endregion
+export { PagefindConfigDefaults, PagefindConfigSchema };

package/dist/schemas/prevNextLink.d.ts

@@ -0,0 +1,10 @@
+import { z } from "astro/zod";
+//#region src/schemas/prevNextLink.d.ts
+declare const PrevNextLinkConfigSchema: () => z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString, z.ZodObject<{
+  link: z.ZodOptional<z.ZodString>;
+  label: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>]>>;
+type PrevNextLinkUserConfig = z.input<ReturnType<typeof PrevNextLinkConfigSchema>>;
+type PrevNextLinkConfig = z.output<ReturnType<typeof PrevNextLinkConfigSchema>>;
+//#endregion
+export { PrevNextLinkConfig, PrevNextLinkConfigSchema, PrevNextLinkUserConfig };

package/dist/schemas/prevNextLink.js

@@ -0,0 +1,14 @@
+import { z } from "astro/zod";
+//#region src/schemas/prevNextLink.ts
+const PrevNextLinkConfigSchema = () => z.union([
+	z.boolean(),
+	z.string(),
+	z.strictObject({
+		/** The navigation link URL. */
+		link: z.string().optional(),
+		/** The navigation link text. */
+		label: z.string().optional()
+	})
+]).optional();
+//#endregion
+export { PrevNextLinkConfigSchema };