starlight-sidebar-topics-dropdown 0.4.0 → 0.4.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # starlight-sidebar-topics-dropdown
 
+## 0.4.1
+
+### Patch Changes
+
+- [`01024d4`](https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown/commit/01024d471326097f20087ac401bd1df4d9a8cd22) Thanks [@trueberryless](https://github.com/trueberryless)! - Small fixes and docs changes
+
 ## 0.4.0
 
 ### Minor Changes

package/index.ts

@@ -7,8 +7,9 @@ import {
   StarlightSidebarTopicsDropdownConfigSchema,
   type StarlightSidebarTopicsDropdownUserConfig,
 } from "./libs/config";
-import { overrideStarlightComponent, throwPluginError } from "./libs/plugin";
+import { throwPluginError } from "./libs/plugin";
 import { vitePluginStarlightSidebarTopicsDropdown } from "./libs/vite";
+import { overrideStarlightComponent } from "./libs/starlight";
 
 export type {
   StarlightSidebarTopicsDropdownConfig,
@@ -68,6 +69,7 @@ export default function starlightSidebarTopicsDropdownPlugin(
             ...overrideStarlightComponent(
               starlightConfig.components,
               logger,
+              "Sidebar",
               "Sidebar"
             ),
           },

package/libs/plugin.ts

@@ -1,5 +1,3 @@
-import type { StarlightUserConfig } from "@astrojs/starlight/types";
-import type { AstroIntegrationLogger } from "astro";
 import { AstroError } from "astro/errors";
 
 export function throwPluginError(message: string, hint?: string): never {
@@ -9,24 +7,3 @@ export function throwPluginError(message: string, hint?: string): never {
       `See the error report above for more informations.\n\nIf you believe this is a bug, please file an issue at https://github.com/trueberryless-org/starlight-sidebar-topics-dropdown/issues/new/choose`
   );
 }
-
-export function overrideStarlightComponent(
-  components: StarlightUserConfig["components"],
-  logger: AstroIntegrationLogger,
-  component: keyof NonNullable<StarlightUserConfig["components"]>
-) {
-  if (components?.[component]) {
-    logger.warn(
-      `It looks like you already have a \`${component}\` component override in your Starlight configuration.`
-    );
-    logger.warn(
-      `To use \`starlight-sidebar-topics-dropdown\`, either remove your override or update it to render the content from \`starlight-sidebar-topics-dropdown/overrides/${component}.astro\`.`
-    );
-
-    return {};
-  }
-
-  return {
-    [component]: `starlight-sidebar-topics-dropdown/overrides/${component}.astro`,
-  };
-}

package/libs/starlight.ts

@@ -14,11 +14,6 @@ export function overrideStarlightComponent(
     logger.warn(
       `To use \`starlight-sidebar-topics-dropdown\`, either remove your override or update it to render the content from \`starlight-sidebar-topics-dropdown/components/${component}.astro\`.`
     );
-    // if (component === "DynamicVersionBadge") {
-    //   logger.warn(
-    //     "Notice that the `DynamicVersionBadge` component must be rendered AFTER the original Starlight `SiteTitle` component in the DOM. This ensures proper layout and behavior within the application."
-    //   );
-    // }
 
     return {};
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "starlight-sidebar-topics-dropdown",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Starlight plugin to split your docs page into multiple subpages and switch between them with a dropdown menu in the sidebar.",
   "keywords": [
     "starlight",