initial commit

README.md

@@ -0,0 +1 @@
+./packages/starlight-utils/README.md

docs/astro.config.mjs

@@ -1,16 +1,16 @@
 import { defineConfig } from "astro/config";
 import starlight from "@astrojs/starlight";
-import starlightMultiSidebar from "@lorenzo_lewis/starlight-nav";
+import starlightUtils from "@lorenzo_lewis/starlight-utils";
 import starlightLinksValidatorPlugin from "starlight-links-validator";
 
 // https://astro.build/config
 export default defineConfig({
-  site: "https://starlight-nav.pages.dev",
+  site: "https://starlight-utils.pages.dev",
   integrations: [
     starlight({
-      title: "🗄️ Starlight Multi-Sidebar",
+      title: "🧰 Starlight Utils",
       social: {
-        github: "https://github.com/lorenzolewis/starlight-multi-sidebar",
+        github: "https://github.com/lorenzolewis/starlight-utils",
       },
       sidebar: [
         {
@@ -23,10 +23,7 @@ export default defineConfig({
           badge: "Demo",
         },
       ],
-      plugins: [
-        starlightMultiSidebar({ switcherStyle: "horizontalList" }),
-        starlightLinksValidatorPlugin(),
-      ],
+      plugins: [starlightUtils(), starlightLinksValidatorPlugin()],
     }),
   ],
 });

docs/package.json

@@ -13,7 +13,7 @@
   "dependencies": {
     "@astrojs/check": "^0.7.0",
     "@astrojs/starlight": "^0.23.1",
-    "@lorenzo_lewis/starlight-multi-sidebar": "workspace:*",
+    "@lorenzo_lewis/starlight-utils": "workspace:*",
     "astro": "^4.8.6",
     "sharp": "^0.33.4",
     "starlight-links-validator": "^0.8.0",

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

@@ -5,56 +5,28 @@ import { PackageManagers } from "starlight-package-managers";
 
 1.  Setup a Starlight Site: https://starlight.astro.build/getting-started/
 
-2.  Install the `starlight-multi-sidebar` plugin:
+2.  Install the `starlight-utils` plugin:
 
-    <PackageManagers pkg="@lorenzo_lewis/starlight-multi-sidebar" />
+    <PackageManagers pkg="@lorenzo_lewis/starlight-utils" />
 
-3.  Update the `integrations.starlight.plugins` object in `astro.config.mjs` to include the `starlight-multi-sidebar` plugin:
+3.  Update the `integrations.starlight.plugins` object in `astro.config.mjs` to include the `starlight-utils` plugin:
 
     ```ts ins={4, 10}
     // astro.config.mjs
     import { defineConfig } from "astro/config";
     import starlight from "@astrojs/starlight";
-    import starlightMultiSidebar from "@lorenzo_lewis/starlight-multi-sidebar";
+    import starlightUtils from "@lorenzo_lewis/starlight-utils";
 
     // https://astro.build/config
     export default defineConfig({
       integrations: [
         starlight({
-          plugins: [starlightMultiSidebar()],
+          plugins: [starlightUtils()],
         }),
       ],
     });
     ```
 
-4.  All top-level items in `integrations.starlight.sidebar` are turned into their own sidebar. Configure each desired sidebar:
-
-    ```ts ins={11-20}
-    // astro.config.mjs
-    import { defineConfig } from "astro/config";
-    import starlight from "@astrojs/starlight";
-    import starlightMultiSidebar from "@lorenzo_lewis/starlight-multi-sidebar";
-
-    // https://astro.build/config
-    export default defineConfig({
-      integrations: [
-        starlight({
-          plugins: [starlightMultiSidebar],
-          sidebar: [
-            {
-              label: "Guides",
-              autogenerate: { directory: "reference" },
-            },
-            {
-              label: "Reference",
-              autogenerate: { directory: "reference" },
-            },
-          ],
-        }),
-      ],
-    });
-    ```
-
-5.  All done! ✨
+4.  All done! ✨
 
 </Steps>

docs/src/content/docs/docs/changelog.mdx

@@ -4,6 +4,6 @@ sidebar:
   order: 3
 ---
 
-import Changelog from "../../../../../packages/starlight-multi-sidebar/CHANGELOG.md";
+import Changelog from "../../../../../packages/starlight-utils/CHANGELOG.md";
 
 <Changelog />

docs/src/content/docs/docs/configuration.md

@@ -3,33 +3,3 @@ title: Configuration
 sidebar:
   order: 2
 ---
-
-There are a few options that can be passed to `starlight-multi-sidebar`. See below for how to configure each of those options
-
-```ts {11-13}
-// astro.config.mjs
-import { defineConfig } from "astro/config";
-import starlight from "@astrojs/starlight";
-import starlightMultiSidebar from "@lorenzo_lewis/starlight-multi-sidebar";
-
-// https://astro.build/config
-export default defineConfig({
-  integrations: [
-    starlight({
-      plugins: [
-        starlightMultiSidebar({
-          switcherStyle: "horizontalList",
-        }),
-      ],
-    }),
-  ],
-});
-```
-
-## `switcherStyle`
-
-**Type:** `"dropdown" | "horizontalList"`
-
-**Default:** `"horizontalList"`
-
-Specifies which style should be used for the sidebar.

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

@@ -4,20 +4,6 @@ sidebar:
   order: 1
 ---
 
-:::caution
-
-This package is still in alpha. There are known issues with accessibility that have not been addressed. If any issues are found please [open an issue on GitHub](https://github.com/lorenzolewis/starlight-multi-sidebar/issues).
-
-:::
-
-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 Starlight plugin gives a minimal implementation of this.
-
-:::tip
-
-Take a look at the sidebar on this page to see what this looks like!
-
-:::
-
 ## Setup Instructions
 
 import Setup from "../_quick-start.mdx";

docs/src/content/docs/index.mdx

@@ -1,5 +1,5 @@
 ---
-title: 🗄️ Starlight Multi-Sidebar
+title: 🧰 Starlight Utils
 description: Enable multiple sidebars with your Starlight site.
 hero:
   tagline: Enable multiple sidebars with your Starlight site.

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "starlight-multi-sidebar-monorepo",
+  "name": "starlight-utils-monorepo",
   "type": "module",
   "version": "0.0.1",
   "license": "MIT",

packages/starlight-utils/README.md

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