@docusaurus/plugin-content-docs 3.10.1-canary-6655 → 3.10.1-canary-6803

package/lib/client/doc.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { useMemo, useContext } from 'react';
-import { ReactContextError } from '@docusaurus/theme-common/internal';
+import { ReactContextError } from '@docusaurus/theme-common';
 const Context = React.createContext(null);
 /**
  * Note: we don't use `PropDoc` as context value on purpose. Metadata is

package/lib/client/docSidebarItemsExpandedState.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { useMemo, useState, useContext } from 'react';
-import { ReactContextError } from '@docusaurus/theme-common/internal';
+import { ReactContextError } from '@docusaurus/theme-common';
 const EmptyContext = Symbol('EmptyContext');
 const Context = React.createContext(EmptyContext);
 /**

package/lib/client/docsPreferredVersion.js

@@ -8,7 +8,7 @@ import React, { useContext, useEffect, useMemo, useState, useCallback, } from 'r
 import { useAllDocsData, useDocsData, } from '@docusaurus/plugin-content-docs/client';
 import { DEFAULT_PLUGIN_ID } from '@docusaurus/constants';
 import { useThemeConfig } from '@docusaurus/theme-common';
-import { ReactContextError, createStorageSlot, } from '@docusaurus/theme-common/internal';
+import { ReactContextError, createStorageSlot } from '@docusaurus/theme-common';
 const storageKey = (pluginId) => `docs-preferred-version-${pluginId}`;
 const DocsPreferredVersionStorage = {
     save: (pluginId, persistence, versionName) => {

package/lib/client/docsSidebar.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { useMemo, useContext } from 'react';
-import { ReactContextError } from '@docusaurus/theme-common/internal';
+import { ReactContextError } from '@docusaurus/theme-common';
 // Using a Symbol because null is a valid context value (a doc with no sidebar)
 // Inspired by https://github.com/jamiebuilds/unstated-next/blob/master/src/unstated-next.tsx
 const EmptyContext = Symbol('EmptyContext');

package/lib/client/docsVersion.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { useContext } from 'react';
-import { ReactContextError } from '@docusaurus/theme-common/internal';
+import { ReactContextError } from '@docusaurus/theme-common';
 const Context = React.createContext(null);
 /**
  * Provide the current version's metadata to your children.

package/lib/client/structuredDataUtils.js

@@ -5,8 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-export function useBreadcrumbsStructuredData({ breadcrumbs, }) {
-    const { siteConfig } = useDocusaurusContext();
+import { applyTrailingSlash } from '@docusaurus/utils-common';
+function getAbsoluteUrl(permalink, params) {
+    const absoluteUrl = `${params.url}${permalink}`;
+    return applyTrailingSlash(absoluteUrl, {
+        trailingSlash: params.trailingSlash,
+        baseUrl: params.baseUrl,
+    });
+}
+function getBreadcrumbsStructuredData({ breadcrumbs, params, }) {
     return {
         '@context': 'https://schema.org',
         '@type': 'BreadcrumbList',
@@ -18,7 +25,11 @@ export function useBreadcrumbsStructuredData({ breadcrumbs, }) {
             '@type': 'ListItem',
             position: index + 1,
             name: breadcrumb.label,
-            item: `${siteConfig.url}${breadcrumb.href}`,
+            item: getAbsoluteUrl(breadcrumb.href, params),
         })),
     };
 }
+export function useBreadcrumbsStructuredData({ breadcrumbs, }) {
+    const { siteConfig } = useDocusaurusContext();
+    return getBreadcrumbsStructuredData({ breadcrumbs, params: siteConfig });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "3.10.1-canary-6655",
+  "version": "3.10.1-canary-6803",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -35,15 +35,15 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.10.1-canary-6655",
-    "@docusaurus/logger": "3.10.1-canary-6655",
-    "@docusaurus/mdx-loader": "3.10.1-canary-6655",
-    "@docusaurus/module-type-aliases": "3.10.1-canary-6655",
-    "@docusaurus/theme-common": "3.10.1-canary-6655",
-    "@docusaurus/types": "3.10.1-canary-6655",
-    "@docusaurus/utils": "3.10.1-canary-6655",
-    "@docusaurus/utils-common": "3.10.1-canary-6655",
-    "@docusaurus/utils-validation": "3.10.1-canary-6655",
+    "@docusaurus/core": "3.10.1-canary-6803",
+    "@docusaurus/logger": "3.10.1-canary-6803",
+    "@docusaurus/mdx-loader": "3.10.1-canary-6803",
+    "@docusaurus/module-type-aliases": "3.10.1-canary-6803",
+    "@docusaurus/theme-common": "3.10.1-canary-6803",
+    "@docusaurus/types": "3.10.1-canary-6803",
+    "@docusaurus/utils": "3.10.1-canary-6803",
+    "@docusaurus/utils-common": "3.10.1-canary-6803",
+    "@docusaurus/utils-validation": "3.10.1-canary-6803",
     "@types/react-router-config": "^5.0.7",
     "combine-promises": "^1.1.0",
     "fs-extra": "^11.2.0",
@@ -55,7 +55,7 @@
     "webpack": "^5.106.2"
   },
   "devDependencies": {
-    "@types/js-yaml": "^4.0.5",
+    "@types/js-yaml": "^4.0.9",
     "@types/picomatch": "^2.3.0",
     "commander": "^5.1.0",
     "picomatch": "^2.3.1"
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=24.14"
   },
-  "gitHead": "6e93a3055178dd0af922ba627f787229dcdf948b"
+  "gitHead": "d2c7b381512bd4e7e90e33f56649e68d618eaa92"
 }

package/src/client/doc.tsx

@@ -6,7 +6,7 @@
  */
 
 import React, {useMemo, type ReactNode, useContext} from 'react';
-import {ReactContextError} from '@docusaurus/theme-common/internal';
+import {ReactContextError} from '@docusaurus/theme-common';
 import type {PropDocContent} from '@docusaurus/plugin-content-docs';
 
 /**

package/src/client/docSidebarItemsExpandedState.tsx

@@ -6,7 +6,7 @@
  */
 
 import React, {type ReactNode, useMemo, useState, useContext} from 'react';
-import {ReactContextError} from '@docusaurus/theme-common/internal';
+import {ReactContextError} from '@docusaurus/theme-common';
 
 type ContextValue = {
   /**

package/src/client/docsPreferredVersion.tsx

@@ -21,10 +21,7 @@ import {
 } from '@docusaurus/plugin-content-docs/client';
 import {DEFAULT_PLUGIN_ID} from '@docusaurus/constants';
 import {useThemeConfig, type ThemeConfig} from '@docusaurus/theme-common';
-import {
-  ReactContextError,
-  createStorageSlot,
-} from '@docusaurus/theme-common/internal';
+import {ReactContextError, createStorageSlot} from '@docusaurus/theme-common';
 
 type DocsVersionPersistence = ThemeConfig['docs']['versionPersistence'];
 

package/src/client/docsSidebar.tsx

@@ -6,7 +6,7 @@
  */
 
 import React, {useMemo, useContext, type ReactNode} from 'react';
-import {ReactContextError} from '@docusaurus/theme-common/internal';
+import {ReactContextError} from '@docusaurus/theme-common';
 import type {PropSidebar} from '@docusaurus/plugin-content-docs';
 
 // Using a Symbol because null is a valid context value (a doc with no sidebar)

package/src/client/docsVersion.tsx

@@ -6,7 +6,7 @@
  */
 
 import React, {type ReactNode, useContext} from 'react';
-import {ReactContextError} from '@docusaurus/theme-common/internal';
+import {ReactContextError} from '@docusaurus/theme-common';
 import type {PropVersionMetadata} from '@docusaurus/plugin-content-docs';
 
 const Context = React.createContext<PropVersionMetadata | null>(null);

package/src/client/structuredDataUtils.ts

@@ -6,15 +6,28 @@
  */
 
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import {applyTrailingSlash} from '@docusaurus/utils-common';
 import type {PropSidebarBreadcrumbsItem} from '@docusaurus/plugin-content-docs';
 import type {WithContext, BreadcrumbList} from 'schema-dts';
+import type {DocusaurusConfig} from '@docusaurus/types';
 
-export function useBreadcrumbsStructuredData({
+type Params = Pick<DocusaurusConfig, 'url' | 'baseUrl' | 'trailingSlash'>;
+
+function getAbsoluteUrl(permalink: string, params: Params): string {
+  const absoluteUrl = `${params.url}${permalink}`;
+  return applyTrailingSlash(absoluteUrl, {
+    trailingSlash: params.trailingSlash,
+    baseUrl: params.baseUrl,
+  });
+}
+
+function getBreadcrumbsStructuredData({
   breadcrumbs,
+  params,
 }: {
   breadcrumbs: PropSidebarBreadcrumbsItem[];
+  params: Params;
 }): WithContext<BreadcrumbList> {
-  const {siteConfig} = useDocusaurusContext();
   return {
     '@context': 'https://schema.org',
     '@type': 'BreadcrumbList',
@@ -26,7 +39,16 @@ export function useBreadcrumbsStructuredData({
         '@type': 'ListItem',
         position: index + 1,
         name: breadcrumb.label,
-        item: `${siteConfig.url}${breadcrumb.href}`,
+        item: getAbsoluteUrl(breadcrumb.href!, params),
       })),
   };
 }
+
+export function useBreadcrumbsStructuredData({
+  breadcrumbs,
+}: {
+  breadcrumbs: PropSidebarBreadcrumbsItem[];
+}): WithContext<BreadcrumbList> {
+  const {siteConfig} = useDocusaurusContext();
+  return getBreadcrumbsStructuredData({breadcrumbs, params: siteConfig});
+}