update some more docs

docs/astro.config.mjs

@@ -1,6 +1,7 @@
 import { defineConfig } from "astro/config";
 import starlight from "@astrojs/starlight";
 import starlightLinksValidatorPlugin from "starlight-links-validator";
+import starlightUtils from "@lorenzo_lewis/starlight-utils";
 
 // https://astro.build/config
 export default defineConfig({
@@ -16,12 +17,16 @@ export default defineConfig({
           label: "Docs",
           autogenerate: { directory: "/docs" },
         },
+        {
+          label: "Utilities",
+          autogenerate: { directory: "/utilities" },
+        },
         {
           label: "References",
           autogenerate: { directory: "/references" },
         },
       ],
-      plugins: [starlightLinksValidatorPlugin()],
+      plugins: [starlightLinksValidatorPlugin(), starlightUtils()],
     }),
   ],
 });

docs/src/content/docs/_quick-start.mdx

@@ -27,6 +27,6 @@ import { PackageManagers } from "starlight-package-managers";
     });
     ```
 
-4.  Go to the [Configuration Guide](/configuration) to continue setting up! ✨
+4.  Go to the [Configuration Guide](/docs/configuration) to learn how to set up the different utilities ✨
 
 </Steps>

docs/src/content/docs/docs/recommended.mdx

@@ -1,3 +1,25 @@
 ---
-title: Recommended Plugins
+title: Recommended Resources
 ---
+
+import { LinkCard, CardGrid } from "@astrojs/starlight/components";
+
+## Plugins
+
+These are plugins not included in this utility but are fantastic to add to your Starlight site.
+
+<CardGrid>
+  <LinkCard
+    title="Starlight Links Validator"
+    description="Starlight plugin to validate internal links."
+    href="https://starlight-links-validator.vercel.app"
+  />
+</CardGrid>
+
+---
+
+<LinkCard
+  title="More Resources"
+  description="Visit the Starlight Plugins and Integrations page for even more amazing resources!"
+  href="https://starlight.astro.build/resources/plugins/"
+/>

docs/src/content/docs/index.mdx

@@ -1,10 +1,9 @@
 ---
 title: 🧰 Starlight Utils
-description: A collection of utilities to build on top of your 🌟 Starlight site.
+description: Utilities to use with your 🌟 Starlight site
 tableOfContents: false
-template: splash
 hero:
-  tagline: A collection of utilities to build on top of your 🌟 Starlight site.
+  tagline: Utilities to use with your 🌟 Starlight site
   image:
     file: ../../assets/houston.webp
   actions:
@@ -14,14 +13,6 @@ hero:
       variant: primary
 ---
 
-import { LinkCard, CardGrid } from "@astrojs/starlight/components";
-
-<CardGrid stagger>
-  <LinkCard />
-  <LinkCard />
-  <LinkCard />
-</CardGrid>
-
 import QuickStart from "./_quick-start.mdx";
 
 ## Quick Start

docs/src/content/docs/references/index.mdx

@@ -1,5 +1,5 @@
 ---
-title: References
+title: API Reference
 sidebar:
   order: 1
 ---

docs/src/content/docs/utilities/index.mdx

@@ -0,0 +1,3 @@
+---
+title: List of Utilities
+---

docs/src/content/docs/utilities/multi-sidebar.mdx

@@ -0,0 +1,43 @@
+---
+title: Multi-Sidebar
+---
+
+There are cases where having multiple sidebars for a Starlight site can be useful. [Starlight does not currently support this natively](https://github.com/withastro/starlight/discussions/959), but this utility gives a minimal implementation of this.
+
+## Demo
+
+import { Sidebar } from "@lorenzo_lewis/starlight-utils/components";
+
+## Configuration
+
+See below for how to configure each of these actions.
+
+```ts {12-14}
+// astro.config.mjs
+import { defineConfig } from "astro/config";
+import starlight from "@astrojs/starlight";
+import starlightUtils from "@lorenzo_lewis/starlight-utils";
+
+// https://astro.build/config
+export default defineConfig({
+  integrations: [
+    starlight({
+      plugins: [
+        starlightUtils({
+          multiSidebar: {
+            switcherStyle: "horizontalList",
+          },
+        }),
+      ],
+    }),
+  ],
+});
+```
+
+## `switcherStyle`
+
+**Type:** `"dropdown" | "horizontalList"`
+
+**Default:** `"horizontalList"`
+
+Specifies which style should be used for the sidebar.

packages/starlight-utils/README.md

@@ -1,5 +1,5 @@
 # 🗄️ Starlight Utils
 
-A collection of utilities to build on top of your 🌟 [Starlight](https://starlight.astro.build) site.
+Utilities to use with your 🌟 [Starlight](https://starlight.astro.build) site.
 
 Visit the documentation for instructions on how to use: https://starlight-utils.pages.dev

packages/starlight-utils/components/index.ts

@@ -0,0 +1,3 @@
+import Sidebar from "../overrides/Sidebar.astro";
+
+export { Sidebar };

packages/starlight-utils/config.ts

@@ -2,9 +2,13 @@ import { AstroError } from "astro/errors";
 import { z } from "astro/zod";
 
 export const configSchema = z
-  .object({ switcherStyle: z.enum(["dropdown", "horizontalList"]) })
+  .object({
+    multiSidebar: z.object({
+      switcherStyle: z.enum(["dropdown", "horizontalList"]),
+    }),
+  })
   .optional()
-  .default({ switcherStyle: "horizontalList" });
+  .default({ multiSidebar: { switcherStyle: "horizontalList" } });
 
 export function validateConfig(userConfig: unknown): StarlightUtilsConfig {
   const config = configSchema.safeParse(userConfig);

packages/starlight-utils/index.ts

@@ -7,13 +7,7 @@ function plugin(userConfig?: StarlightUtilsConfig): StarlightPlugin {
   return {
     name: "starlight-utils",
     hooks: {
-      setup({ config, updateConfig, addIntegration }) {
-        updateConfig({
-          components: {
-            ...config.components,
-            Sidebar: "@lorenzo_lewis/starlight-utils/overrides/Sidebar.astro",
-          },
-        });
+      setup({ addIntegration }) {
         addIntegration(integration(multiSidebarConfig));
       },
     },

packages/starlight-utils/package.json

@@ -3,15 +3,13 @@
   "author": "Lorenzo Lewis",
   "version": "0.0.1",
   "license": "MIT",
-  "description": "A collection of utilities to build on top of your 🌟 Starlight site.",
+  "description": "Utilities to use with your 🌟 Starlight site.",
   "type": "module",
   "exports": {
     ".": "./index.ts",
-    "./overrides/Sidebar.astro": "./overrides/Sidebar.astro"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "./components": "./components/index.ts"
   },
+  "scripts": {},
   "devDependencies": {
     "@astrojs/starlight": "^0.23.1",
     "astro": "^4.8.6"