Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

The structured data items may contain fields that do not comply with Google's guidelines, which can negatively impact SEO. #9319

Open
7 tasks done
TingJianZheng opened this issue Sep 18, 2023 · 6 comments
Open
7 tasks done

The structured data items may contain fields that do not comply with Google's guidelines, which can negatively impact SEO. #9319

TingJianZheng opened this issue Sep 18, 2023 · 6 comments
Labels
bug An error in the Docusaurus core causing instability or issues with its execution

Comments

@TingJianZheng
Copy link

Have you read the Contributing Guidelines on issues?

Prerequisites

  • I'm using the latest version of Docusaurus.
  • I have tried the npm run clear or yarn clear command.
  • I have tried rm -rf node_modules yarn.lock package-lock.json and re-installing packages.
  • I have tried creating a repro with https://new.docusaurus.io.
  • I have read the console error message carefully (if applicable).

Description

image

node_modules/@docusaurus/theme-classic/lib/theme/DocBreadcrumbs/index.js
Why is an href required here to add a ListItem? It seems like there might be some issues with this approach. (For objects of type "BreadcrumbList," schemas such as schema.org don't recognize "position" as a valid property.)

reference file: https://developers.google.com/search/docs/appearance/structured-data/breadcrumb#structured-data-type-definitions
image

Reproducible demo

No response

Steps to reproduce

, In the SidebarsConfig, whenever an element's type is "Category" and it doesn't need to include the href attribute, you may encounter this issue of structured data inconsistency.
image

Expected behavior

I believe there's no need to determine whether it's part of the breadcrumb navigation based on the presence of href here, as this is already within the breadcrumb navigation itself.

Actual behavior

image image `node_modules/@docusaurus/theme-classic/lib/theme/DocBreadcrumbs/index.js `

The href is an optional attribute, but it is used to determine whether it is a part of the breadcrumb.


image

Your environment

  • Public source code:
  • Public site URL:
  • Docusaurus version used:
  • Environment name and version (e.g. Chrome 89, Node.js 16.4):
  • Operating system and version (e.g. Ubuntu 20.04.2 LTS):

Self-service

  • I'd be willing to fix this bug myself.
@TingJianZheng TingJianZheng added bug An error in the Docusaurus core causing instability or issues with its execution status: needs triage This issue has not been triaged by maintainers labels Sep 18, 2023
@TingJianZheng
Copy link
Author

version: v2.3.1

@slorber
Copy link
Collaborator

slorber commented Sep 18, 2023 •
edited
Loading

Hey 👋

First when opening bugs, please make sure to always use the latest stable version. In this case it doesn't seem to matter, but it could.

It seems that change was done for a reason by @Josh-Cena here: #7304

I'm not 100% sure to understand what is your suggestion and why. A real, concrete example always helps.

My suggestion:

  • take a real page html microdata source html
  • show us what it is before
  • tweak it and show us what it should be (actual vs expected)
  • make sure your new html file pass validation

@slorber slorber removed the status: needs triage This issue has not been triaged by maintainers label Sep 18, 2023
@slorber
Copy link
Collaborator

slorber commented Sep 18, 2023

@johnnyreilly any opinion on the suggested change?

@TingJianZheng
Copy link
Author

Hello, the following HTML website was selected from your official user cases, and it has the same issue as mine – both failed to pass the validation of schema.org and Google.

The validation tool's website - schema.org
Google

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-what-is-docsearch">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.4.1">
<title data-rh="true">What is DocSearch? | DocSearch by Algolia</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://docsearch.algolia.com/img/og_image.png"><meta data-rh="true" name="twitter:image" content="https://docsearch.algolia.com/img/og_image.png"><meta data-rh="true" property="og:url" content="https://docsearch.algolia.com/docs/what-is-docsearch"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="google-site-verification" content="23yIHmCD_xnJb_6e3s-w7M29Kydahk-d86ObMWOrvRg"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="What is DocSearch? | DocSearch by Algolia"><meta data-rh="true" name="description" content="Why?"><meta data-rh="true" property="og:description" content="Why?"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docsearch.algolia.com/docs/what-is-docsearch"><link data-rh="true" rel="alternate" href="https://docsearch.algolia.com/docs/what-is-docsearch" hreflang="en"><link data-rh="true" rel="alternate" href="https://docsearch.algolia.com/docs/what-is-docsearch" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://R2IYF7ETH7-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="DocSearch by Algolia" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.2382502b.css">
<link rel="preload" href="/assets/js/runtime~main.9eb232c2.js" as="script">
<link rel="preload" href="/assets/js/main.5c5c75c5.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();null!==e?t(e):window.matchMedia("(prefers-color-scheme: dark)").matches?t("dark"):(window.matchMedia("(prefers-color-scheme: light)").matches,t("light"))}(),document.documentElement.setAttribute("data-announcement-bar-initially-dismissed",function(){try{return"true"===localStorage.getItem("docusaurus.announcement.dismiss")}catch(t){}return!1}())</script><div id="__docusaurus">
<div role="region" aria-label="Skip to main content"><a class="skipToContent_G6ar" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><div class="announcementBar_ncOr" role="banner"><div class="announcementBarPlaceholder_ajMw"></div><div class="content_L1uV announcementBarContent__57G">⭐️ If you like DocSearch, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/algolia/docsearch">GitHub</a>! ⭐️</div><button type="button" aria-label="Close" class="clean-btn close closeButton_rfix announcementBarClose_c9u4"><svg viewBox="0 0 15 15" width="14" height="14"><g stroke="currentColor" stroke-width="3.1"><path d="M.75.75l13.5 13.5M14.25.75L.75 14.25"></path></g></svg></button></div><nav aria-label="Main" class="navbar navbar--fixed-top navbarHideable_bChn"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/docsearch-logo.svg" alt="DocSearch" class="themedImage_RWGG themedImage--light_riBm"><img src="/img/docsearch-logo-white.svg" alt="DocSearch" class="themedImage_RWGG themedImage--dark_Dsi0"></div></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/what-is-docsearch">Docs</a><a class="navbar__item navbar__link" href="/apply">Apply</a></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a aria-current="page" class="navbar__link active" aria-haspopup="true" aria-expanded="false" role="button" href="/docs/what-is-docsearch">current</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/what-is-docsearch">current</a></li><li><a class="dropdown__link" href="/docs/legacy/dropdown">legacy</a></li></ul></div><a href="https://github.com/algolia/docsearch" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link"></a><div class="toggle_OLSw colorModeToggle_Hg9V"><button class="clean-btn toggleButton_wYmb toggleButtonDisabled_vaDU" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_Sxwe"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_Yem1"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_xrOJ"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_UyTV docsWrapper_BqXd"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_z1FD" type="button"></button><div class="docPage_pOTq"><aside class="theme-doc-sidebar-container docSidebarContainer_aIKW"><div class="sidebarViewport_DwR9"><div class="sidebar_vJCc sidebarWithHideableNavbar_Fo4g"><a tabindex="-1" class="sidebarLogo_nlll" href="/"><img src="/img/docsearch-logo.svg" alt="DocSearch" class="themedImage_RWGG themedImage--light_riBm"><img src="/img/docsearch-logo-white.svg" alt="DocSearch" class="themedImage_RWGG themedImage--dark_Dsi0"></a><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_qiME menuWithAnnouncementBar_hRfJ"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/what-is-docsearch">Introduction</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/what-is-docsearch">What is DocSearch?</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/who-can-apply">Who can apply?</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/migrating-from-legacy">Migrating from the legacy scraper</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/DocSearch-v3">DocSearch v3</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/record-extractor">Algolia Crawler</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/crawler">Requirements, tips, FAQ</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/how-does-it-work">Under the hood</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_fv3b"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_YAwJ"><div class="docItemContainer_Rv5Z"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_zCmv" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_JFrk"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Introduction</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">What is DocSearch?</span><meta itemprop="position" content="2"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: current</span><div class="tocCollapsible_O_Qc theme-doc-toc-mobile tocMobile_tjDr"><button type="button" class="clean-btn tocCollapsibleButton_htYj">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>What is DocSearch?</h1></header><h2 class="anchor anchorWithHideOnScrollNavbar_Yh18" id="why">Why?<a href="#why" class="hash-link" aria-label="Direct link to Why?" title="Direct link to Why?">​</a></h2><p>We have created DocSearch because we are scratching our own itch. As developers, we spent a lot of time reading documentation, and it can be hard to find relevant information in large documentations. We&#x27;re not blaming anyone here; building a good search is a challenge.</p><p>It happens that we are a search company and we actually have a lot of experience building search interfaces. We wanted to use those skills to help others. That&#x27;s why we created a way to automatically extract content from tech documentation and make it available to everyone from the first keystroke.</p><h2 class="anchor anchorWithHideOnScrollNavbar_Yh18" id="quick-description">Quick description<a href="#quick-description" class="hash-link" aria-label="Direct link to Quick description" title="Direct link to Quick description">​</a></h2><p>We split DocSearch into a crawler and a frontend library.</p><ul><li>Crawls are handled by the <a href="https://www.algolia.com/products/search-and-discovery/crawler/" target="_blank" rel="noopener noreferrer">Algolia Crawler</a> and scheduled to run once a week by default, you can then trigger new crawls yourself and monitor them directly from the <a href="https://crawler.algolia.com/" target="_blank" rel="noopener noreferrer">Crawler interface</a>, which also offers a live editor where you can maintain your config.</li><li>The frontend library is built on top of <a href="https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/" target="_blank" rel="noopener noreferrer">Algolia Autocomplete</a> and provides an immersive search experience through its modal.</li></ul><h2 class="anchor anchorWithHideOnScrollNavbar_Yh18" id="how-to-feature-docsearch">How to feature DocSearch?<a href="#how-to-feature-docsearch" class="hash-link" aria-label="Direct link to How to feature DocSearch?" title="Direct link to How to feature DocSearch?">​</a></h2><p>DocSearch is entirely free and automated. The one thing we&#x27;ll need from you is to read <a href="/docs/who-can-apply">our checklist</a> and apply! After that, we&#x27;ll share with you the snippet needed to add DocSearch to your website. We ask that you keep the &quot;Search by Algolia&quot; link displayed.</p><p>DocSearch is <a href="https://opencollective.com/algolia" target="_blank" rel="noopener noreferrer">one of our ways</a> to give back to the open source community for everything it did for us already.</p><p>You can now <a href="/apply">apply to the program</a></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/algolia/docsearch/edit/main/packages/website/docs/what-is-docsearch.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_UohW" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_T23F"><span class="theme-last-updated">Last updated<!-- --> on <b><time datetime="2022-01-10T19:33:59.000Z">Jan 10, 2022</time></b> by <b>Tyson Williams</b></span></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--next" href="/docs/who-can-apply"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Who can apply?</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_TN1Q thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#why" class="table-of-contents__link toc-highlight">Why?</a></li><li><a href="#quick-description" class="table-of-contents__link toc-highlight">Quick description</a></li><li><a href="#how-to-feature-docsearch" class="table-of-contents__link toc-highlight">How to feature DocSearch?</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/what-is-docsearch">Getting Started</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/docsearch-program">FAQ</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/DocSearch-v3">DocSearch v3</a></li></ul></div><div class="col footer__col"><div class="footer__title">DocSearch</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/apply">Apply</a></li><li class="footer__item"><a href="https://github.com/algolia/docsearch/issues" target="_blank" rel="noopener noreferrer" class="footer__link-item">Issues</a></li><li class="footer__item"><a href="https://www.algolia.com/policies/privacy/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Privacy</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://discourse.algolia.com/tags/docsearch" target="_blank" rel="noopener noreferrer" class="footer__link-item">Forum</a></li><li class="footer__item"><a href="https://discord.com/invite/bRTacwYrfX" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord</a></li></ul></div><div class="col footer__col"><div class="footer__title">Social</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/algolia/docsearch" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub</a></li><li class="footer__item"><a href="https://twitter.com/docsearch_" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter</a></li><li class="footer__item"><a href="https://algolia.com/blog/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Algolia Blog</a></li></ul></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><img src="/img/Algolia-logo-blue.svg" alt="Algolia" class="themedImage_RWGG themedImage--light_riBm footer__logo" width="200"><img src="/img/Algolia-logo-white.svg" alt="Algolia" class="themedImage_RWGG themedImage--dark_Dsi0 footer__logo" width="200"></div><div class="footer__copyright">DocSearch 2015-now • Designed and built by Algolia</div></div></div></footer></div>
<script src="/assets/js/runtime~main.9eb232c2.js"></script>
<script src="/assets/js/main.5c5c75c5.js"></script>
</body>
</html>

@slorber
Copy link
Collaborator

slorber commented Sep 19, 2023 •
edited
Loading

Thanks @TingJianZheng

And now can you please modify manually this HTML to show what exactly should be the desired output? This way we can validate the desired output and see if tools like it better. And then we can try to provide the dDocusaurus implementation to emit that output.

Why is an href required here to add a ListItem? It seems like there might be some issues with this approach. (For objects of type "BreadcrumbList," schemas such as schema.org don't recognize "position" as a valid property.)

I don't understand your text here, that's also why I ask for a very concrete before/after example. According to what I see in our code, href and position are not related 🤷‍♂️

By the way Google seems to be ok with your Algolia page example:

CleanShot 2023-09-19 at 11 35 52@2x

@johnnyreilly
Copy link
Contributor

johnnyreilly commented Sep 19, 2023 •
edited
Loading

Hi @slorber, I suspect that migrating from microdata to JSON-LD structured data (as I've proposed for blogs here: #9274) would resolve the issue. That's likely a cleaner approach.

Fwiw I've swizzled breadcrumb JSON-LD structured data on my blog and it's pretty straightforward - I've written about it here: https://johnnyreilly.com/docusaurus-blogs-adding-breadcrumb-structured-data

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug An error in the Docusaurus core causing instability or issues with its execution
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@slorber @johnnyreilly @TingJianZheng