@docusaurus/plugin-content-docs/lib/client/structuredDataUtils.js

Docs plugin for Docusaurus.

/**
 * 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}`,
        })),
    };
}