fix(theme): add __ prefix to technical anchors, search crawlers (Algo…

…lia) should ignore them (#8909)
facebook · Apr 20, 2023 · d220f48 · d220f48
1 parent f154b2f
commit d220f48
Show file tree

Hide file tree

Showing 12 changed files with 22 additions and 16 deletions.
diff --git a/...s__/__fixtures__/website/build-snap/blog/2018/12/14/Happy-First-Birthday-Slash/index.html b/...s__/__fixtures__/website/build-snap/blog/2018/12/14/Happy-First-Birthday-Slash/index.html
diff --git a/...in-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/date-matter/index.html b/...in-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/date-matter/index.html
diff --git a/...ntent-blog/src/__tests__/__fixtures__/website/build-snap/blog/heading-as-title/index.html b/...ntent-blog/src/__tests__/__fixtures__/website/build-snap/blog/heading-as-title/index.html
diff --git a/...log/src/__tests__/__fixtures__/website/build-snap/blog/hey/my super path/héllô/index.html b/...log/src/__tests__/__fixtures__/website/build-snap/blog/hey/my super path/héllô/index.html
diff --git a/...-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/mdx-blog-post/index.html b/...-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/mdx-blog-post/index.html
diff --git a/...-blog/src/__tests__/__fixtures__/website/build-snap/blog/mdx-require-blog-post/index.html b/...-blog/src/__tests__/__fixtures__/website/build-snap/blog/mdx-require-blog-post/index.html
diff --git a/...in-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/simple/slug/index.html b/...in-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/simple/slug/index.html
diff --git a/...lugin-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/unlisted/index.html b/...lugin-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/unlisted/index.html
diff --git a/packages/docusaurus-theme-common/src/utils/skipToContentUtils.tsx b/packages/docusaurus-theme-common/src/utils/skipToContentUtils.tsx
@@ -14,8 +14,11 @@ import {useLocationChange} from './useLocationChange';
  * The id of the element that should become focused on a page
  * that does not have a <main> html tag.
  * Focusing the Docusaurus Layout children is a reasonable fallback.
+ *
+ * __ prefix allows search crawlers (Algolia/DocSearch) to ignore anchors
+ * https://github.com/facebook/docusaurus/issues/8883#issuecomment-1516328368
  */
-export const SkipToContentFallbackId = 'docusaurus_skipToContent_fallback';
+export const SkipToContentFallbackId = '__docusaurus_skipToContent_fallback';
 
 /**
  * Returns the skip to content element to focus when the link is clicked.

diff --git a/packages/docusaurus-utils-common/src/index.ts b/packages/docusaurus-utils-common/src/index.ts
@@ -5,7 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-export const blogPostContainerID = 'post-content';
+// __ prefix allows search crawlers (Algolia/DocSearch) to ignore anchors
+// https://github.com/facebook/docusaurus/issues/8883#issuecomment-1516328368
+export const blogPostContainerID = '__blog-post-container';
+
 export {
   default as applyTrailingSlash,
   type ApplyTrailingSlashParams,

diff --git a/packages/docusaurus/src/client/BaseUrlIssueBanner/index.tsx b/packages/docusaurus/src/client/BaseUrlIssueBanner/index.tsx
@@ -14,12 +14,12 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 // Double-security: critical CSS will hide the banner if CSS can load!
 import './styles.module.css';
 
-const BannerContainerId = 'docusaurus-base-url-issue-banner-container';
-
-const BannerId = 'docusaurus-base-url-issue-banner';
-
+// __ prefix allows search crawlers (Algolia/DocSearch) to ignore anchors
+// https://github.com/facebook/docusaurus/issues/8883#issuecomment-1516328368
+const BannerContainerId = '__docusaurus-base-url-issue-banner-container';
+const BannerId = '__docusaurus-base-url-issue-banner';
 const SuggestionContainerId =
-  'docusaurus-base-url-issue-banner-suggestion-container';
+  '__docusaurus-base-url-issue-banner-suggestion-container';
 
 const InsertBannerWindowAttribute = '__DOCUSAURUS_INSERT_BASEURL_BANNER';
 

diff --git a/packages/docusaurus/src/client/BaseUrlIssueBanner/styles.module.css b/packages/docusaurus/src/client/BaseUrlIssueBanner/styles.module.css
@@ -5,6 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-:global(#docusaurus-base-url-issue-banner-container) {
+:global(#__docusaurus-base-url-issue-banner-container) {
   display: none;
 }