starlight-view-modes/libs/starlight.ts

Starlight plugin adding view mode capabilities to your documentation website.

import type { StarlightUserConfig } from "@astrojs/starlight/types";
import type { AstroIntegrationLogger } from "astro";

export function overrideStarlightComponent(
  components: StarlightUserConfig["components"],
  logger: AstroIntegrationLogger,
  override: keyof NonNullable<StarlightUserConfig["components"]>,
  component: string
) {
  if (components?.[override]) {
    logger.warn(
      `It looks like you already have a \`${override}\` component override in your Starlight configuration.`
    );
    logger.warn(
      `To use \`starlight-view-modes\`, either remove your override or update it to render the content from \`starlight-view-modes/components/${component}.astro\`.`
    );
    if (component === "DefaultBottomTableOfContentsWrapper") {
      logger.warn(
        "Notice that the `DefaultBottomTableOfContentsWrapper` component must be rendered AFTER the original Starlight `TableOfContents` component in the DOM. This ensures proper layout and behavior within the application."
      );
    }

    return {};
  }

  return {
    [override]: `starlight-view-modes/overrides/${override}.astro`,
  };
}