fix(vitepress): correctly handle base sidebar paths in windows

typedoc2md · Jan 7, 2025 · 53a52e5 · 53a52e5
1 parent 51245fd
commit 53a52e5
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -14,7 +14,6 @@
     "@devtools/*",
     "typedoc-github-wiki-theme",
     "typedoc-gitlab-wiki-theme",
-    "typedoc-vitepress-theme",
     "typedoc-plugin-frontmatter"
   ]
 }
diff --git a/.changeset/rude-readers-hope.md b/.changeset/rude-readers-hope.md
@@ -0,0 +1,5 @@
+---
+'typedoc-vitepress-theme': patch
+---
+
+- Correctly handle base sidebar paths in windows (#756).
diff --git a/packages/typedoc-vitepress-theme/package.json b/packages/typedoc-vitepress-theme/package.json
@@ -30,7 +30,7 @@
     "test:update": "npm run build && npm test -- -u"
   },
   "peerDependencies": {
-    "typedoc-plugin-markdown": ">=4.4.1"
+    "typedoc-plugin-markdown": ">=4.4.0"
   },
   "license": "MIT",
   "keywords": [

diff --git a/packages/typedoc-vitepress-theme/src/index.ts b/packages/typedoc-vitepress-theme/src/index.ts
@@ -59,8 +59,9 @@ export function load(app: MarkdownApplication) {
     if (sidebarOptions.autoConfiguration && output.navigation) {
       const outDir = app.options.getValue('out');
       const sidebarPath = path.resolve(outDir, 'typedoc-sidebar.json');
-      const basePath = path.relative(app.options.getValue('docsRoot'), outDir);
-
+      const basePath = path
+        .relative(app.options.getValue('docsRoot'), outDir)
+        .replace(/\\/g, '/');
       const sidebarJson = getSidebar(
         output.navigation,
         basePath,