editUrl fn => always inject posix style relative paths, make tests mo…

…re reliable (see also #4124)
facebook · Jan 29, 2021 · 26be22c · 26be22c
1 parent 8344061
commit 26be22c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/packages/docusaurus-plugin-content-blog/src/blogUtils.ts b/packages/docusaurus-plugin-content-blog/src/blogUtils.ts
@@ -26,6 +26,7 @@ import {
   aliasedSitePath,
   getEditUrl,
   getFolderContainingFile,
+  posixPath,
 } from '@docusaurus/utils';
 import {LoadContext} from '@docusaurus/types';
 import {keyBy} from 'lodash';
@@ -143,8 +144,8 @@ export async function generateBlogPosts(
 
         if (typeof siteEditUrl === 'function') {
           return siteEditUrl({
-            blogDirPath: path.relative(siteDir, blogDirPath),
-            blogPath: blogPathRelative, // good enough doc info for now?
+            blogDirPath: posixPath(path.relative(siteDir, blogDirPath)),
+            blogPath: posixPath(blogPathRelative),
             locale: i18n.currentLocale,
           });
         } else if (typeof siteEditUrl === 'string') {

diff --git a/packages/docusaurus-plugin-content-docs/src/docs.ts b/packages/docusaurus-plugin-content-docs/src/docs.ts
@@ -13,6 +13,7 @@ import {
   getFolderContainingFile,
   normalizeUrl,
   parseMarkdownString,
+  posixPath,
 } from '@docusaurus/utils';
 import {LoadContext} from '@docusaurus/types';
 
@@ -124,8 +125,10 @@ export function processDocMetadata({
     if (typeof options.editUrl === 'function') {
       return options.editUrl({
         version: versionMetadata.versionName,
-        versionDocsDirPath: path.relative(siteDir, versionMetadata.docsDirPath),
-        docPath: relativeFilePath, // good enough doc info for now?
+        versionDocsDirPath: posixPath(
+          path.relative(siteDir, versionMetadata.docsDirPath),
+        ),
+        docPath: posixPath(relativeFilePath),
         locale: context.i18n.currentLocale,
       });
     } else if (typeof options.editUrl === 'string') {