Merge pull request #62 from HiDeoo/hd-sidebar-slugs

HiDeoo · Nov 8, 2024 · 93bf268 · 93bf268
2 parents e41a380 + 16f931b
commit 93bf268
Show file tree

Hide file tree

Showing 6 changed files with 674 additions and 599 deletions.
diff --git a/docs/package.json b/docs/package.json
@@ -13,9 +13,9 @@
     "lint": "prettier -c --cache . && eslint . --cache --max-warnings=0"
   },
   "dependencies": {
-    "@astrojs/starlight": "0.24.4",
+    "@astrojs/starlight": "0.25.0",
     "@hideoo/starlight-plugins-docs-components": "^0.2.2",
-    "astro": "4.11.1",
+    "astro": "4.16.10",
     "sharp": "0.32.6"
   },
   "engines": {

diff --git a/example/astro.config.ts b/example/astro.config.ts
@@ -24,7 +24,7 @@ export default defineConfig({
       sidebar: [
         {
           label: 'Guides',
-          items: [{ label: 'Example Guide', link: '/guides/example/' }],
+          items: ['guides/example'],
         },
         typeDocSidebarGroup,
       ],

diff --git a/example/package.json b/example/package.json
@@ -18,8 +18,8 @@
     "lint": "prettier -c --cache . && eslint . --cache --max-warnings=0"
   },
   "dependencies": {
-    "@astrojs/starlight": "0.24.4",
-    "astro": "4.11.1",
+    "@astrojs/starlight": "0.25.0",
+    "astro": "4.16.10",
     "sharp": "0.32.6",
     "starlight-typedoc": "workspace:*",
     "typedoc": "0.26.5",

diff --git a/packages/starlight-typedoc/libs/starlight.ts b/packages/starlight-typedoc/libs/starlight.ts
@@ -111,7 +111,7 @@ function getSidebarGroupFromReflections(
       .flatMap((group) => {
         if (group.title === 'Modules') {
           return group.children.map((child) => {
-            if (!child.url) {
+            if (!child.url || child.variant === 'document') {
               return undefined
             }
 
@@ -230,7 +230,7 @@ export function getStarlightTypeDocOutputDirectory(outputDirectory: string, base
 }
 
 function isSidebarManualGroup(item: NonNullable<StarlightUserConfigSidebar>[number]): item is SidebarManualGroup {
-  return 'items' in item
+  return typeof item === 'object' && 'items' in item
 }
 
 function isReferenceReflectionGroup(group: ReflectionGroup) {

diff --git a/packages/starlight-typedoc/package.json b/packages/starlight-typedoc/package.json
@@ -26,17 +26,16 @@
     "github-slugger": "2.0.0"
   },
   "devDependencies": {
-    "@astrojs/starlight": "0.24.4",
+    "@astrojs/starlight": "0.25.0",
     "@playwright/test": "1.35.0",
     "@types/node": "18.16.16",
-    "astro": "4.11.1",
+    "astro": "4.16.10",
     "cross-env": "7.0.3",
     "typescript": "5.1.6",
     "vitest": "1.0.4"
   },
   "peerDependencies": {
-    "@astrojs/starlight": ">=0.15.0",
-    "astro": ">=4.0.0",
+    "@astrojs/starlight": ">=0.25.0",
     "typedoc": ">=0.26.5",
     "typedoc-plugin-markdown": ">=4.1.1"
   },