@docusaurus/plugin-content-docs 3.7.0-canary-6226 → 3.7.0-canary-6228

package/lib/client/index.d.ts

@@ -13,6 +13,7 @@ export { DocsSidebarProvider, useDocsSidebar } from './docsSidebar';
 export { DocProvider, useDoc, type DocContextValue } from './doc';
 export { useDocsPreferredVersionByPluginId, DocsPreferredVersionContextProvider, } from './docsPreferredVersion';
 export { useDocsContextualSearchTags, getDocsVersionSearchTag, } from './docsSearch';
+export { useBreadcrumbsStructuredData } from './structuredDataUtils';
 export type ActivePlugin = {
     pluginId: string;
     pluginData: GlobalPluginData;

package/lib/client/index.js

@@ -15,6 +15,7 @@ export { DocsSidebarProvider, useDocsSidebar } from './docsSidebar';
 export { DocProvider, useDoc } from './doc';
 export { useDocsPreferredVersionByPluginId, DocsPreferredVersionContextProvider, } from './docsPreferredVersion';
 export { useDocsContextualSearchTags, getDocsVersionSearchTag, } from './docsSearch';
+export { useBreadcrumbsStructuredData } from './structuredDataUtils';
 // Important to use a constant object to avoid React useEffect executions etc.
 // see https://github.com/facebook/docusaurus/issues/5089
 const StableEmptyObject = {};

package/lib/client/structuredDataUtils.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { PropSidebarBreadcrumbsItem } from '@docusaurus/plugin-content-docs';
+import type { WithContext, BreadcrumbList } from 'schema-dts';
+export declare function useBreadcrumbsStructuredData({ breadcrumbs, }: {
+    breadcrumbs: PropSidebarBreadcrumbsItem[];
+}): WithContext<BreadcrumbList>;

package/lib/client/structuredDataUtils.js

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+export function useBreadcrumbsStructuredData({ breadcrumbs, }) {
+    const { siteConfig } = useDocusaurusContext();
+    return {
+        '@context': 'https://schema.org',
+        '@type': 'BreadcrumbList',
+        itemListElement: breadcrumbs
+            // We filter breadcrumb items without links, they are not allowed
+            // See also https://github.com/facebook/docusaurus/issues/9319#issuecomment-2643560845
+            .filter((breadcrumb) => breadcrumb.href)
+            .map((breadcrumb, index) => ({
+            '@type': 'ListItem',
+            position: index + 1,
+            name: breadcrumb.label,
+            item: `${siteConfig.url}${breadcrumb.href}`,
+        })),
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "3.7.0-canary-6226",
+  "version": "3.7.0-canary-6228",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -35,20 +35,21 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.7.0-canary-6226",
-    "@docusaurus/logger": "3.7.0-canary-6226",
-    "@docusaurus/mdx-loader": "3.7.0-canary-6226",
-    "@docusaurus/module-type-aliases": "3.7.0-canary-6226",
-    "@docusaurus/theme-common": "3.7.0-canary-6226",
-    "@docusaurus/types": "3.7.0-canary-6226",
-    "@docusaurus/utils": "3.7.0-canary-6226",
-    "@docusaurus/utils-common": "3.7.0-canary-6226",
-    "@docusaurus/utils-validation": "3.7.0-canary-6226",
+    "@docusaurus/core": "3.7.0-canary-6228",
+    "@docusaurus/logger": "3.7.0-canary-6228",
+    "@docusaurus/mdx-loader": "3.7.0-canary-6228",
+    "@docusaurus/module-type-aliases": "3.7.0-canary-6228",
+    "@docusaurus/theme-common": "3.7.0-canary-6228",
+    "@docusaurus/types": "3.7.0-canary-6228",
+    "@docusaurus/utils": "3.7.0-canary-6228",
+    "@docusaurus/utils-common": "3.7.0-canary-6228",
+    "@docusaurus/utils-validation": "3.7.0-canary-6228",
     "@types/react-router-config": "^5.0.7",
     "combine-promises": "^1.1.0",
     "fs-extra": "^11.1.1",
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
+    "schema-dts": "^1.1.2",
     "tslib": "^2.6.0",
     "utility-types": "^3.10.0",
     "webpack": "^5.88.1"
@@ -67,5 +68,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "3cf0275e790bbdc3c77c1da052da78574893d9e1"
+  "gitHead": "3f8026882f9caca53ae9d217f12bfc26db79bba3"
 }

package/src/client/index.ts

@@ -60,6 +60,8 @@ export {
   getDocsVersionSearchTag,
 } from './docsSearch';
 
+export {useBreadcrumbsStructuredData} from './structuredDataUtils';
+
 export type ActivePlugin = {
   pluginId: string;
   pluginData: GlobalPluginData;

package/src/client/structuredDataUtils.ts

@@ -0,0 +1,32 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import type {PropSidebarBreadcrumbsItem} from '@docusaurus/plugin-content-docs';
+import type {WithContext, BreadcrumbList} from 'schema-dts';
+
+export function useBreadcrumbsStructuredData({
+  breadcrumbs,
+}: {
+  breadcrumbs: PropSidebarBreadcrumbsItem[];
+}): WithContext<BreadcrumbList> {
+  const {siteConfig} = useDocusaurusContext();
+  return {
+    '@context': 'https://schema.org',
+    '@type': 'BreadcrumbList',
+    itemListElement: breadcrumbs
+      // We filter breadcrumb items without links, they are not allowed
+      // See also https://github.com/facebook/docusaurus/issues/9319#issuecomment-2643560845
+      .filter((breadcrumb) => breadcrumb.href)
+      .map((breadcrumb, index) => ({
+        '@type': 'ListItem',
+        position: index + 1,
+        name: breadcrumb.label,
+        item: `${siteConfig.url}${breadcrumb.href}`,
+      })),
+  };
+}