Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit b345e9b

Browse files
committedMay 15, 2023
fix(theme): add __ prefix to technical anchors, search crawlers (Algolia) should ignore them (#8909)
1 parent 8346c23 commit b345e9b

File tree

11 files changed

+21
-15
lines changed

11 files changed

+21
-15
lines changed
 

‎packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/2018/12/14/Happy-First-Birthday-Slash/index.html

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/date-matter/index.html

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/heading-as-title/index.html

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/hey/my super path/héllô/index.html

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/mdx-blog-post/index.html

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/mdx-require-blog-post/index.html

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/simple/slug/index.html

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/docusaurus-theme-common/src/utils/skipToContentUtils.tsx

+4-1
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,11 @@ import {useLocationChange} from './useLocationChange';
1414
* The id of the element that should become focused on a page
1515
* that does not have a <main> html tag.
1616
* Focusing the Docusaurus Layout children is a reasonable fallback.
17+
*
18+
* __ prefix allows search crawlers (Algolia/DocSearch) to ignore anchors
19+
* https://github.com/facebook/docusaurus/issues/8883#issuecomment-1516328368
1720
*/
18-
export const SkipToContentFallbackId = 'docusaurus_skipToContent_fallback';
21+
export const SkipToContentFallbackId = '__docusaurus_skipToContent_fallback';
1922

2023
/**
2124
* Returns the skip to content element to focus when the link is clicked.

‎packages/docusaurus-utils-common/src/index.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55
* LICENSE file in the root directory of this source tree.
66
*/
77

8-
export const blogPostContainerID = 'post-content';
8+
// __ prefix allows search crawlers (Algolia/DocSearch) to ignore anchors
9+
// https://github.com/facebook/docusaurus/issues/8883#issuecomment-1516328368
10+
export const blogPostContainerID = '__blog-post-container';
11+
912
export {
1013
default as applyTrailingSlash,
1114
type ApplyTrailingSlashParams,

‎packages/docusaurus/src/client/BaseUrlIssueBanner/index.tsx

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
1414
// Double-security: critical CSS will hide the banner if CSS can load!
1515
import './styles.module.css';
1616

17-
const BannerContainerId = 'docusaurus-base-url-issue-banner-container';
18-
19-
const BannerId = 'docusaurus-base-url-issue-banner';
20-
17+
// __ prefix allows search crawlers (Algolia/DocSearch) to ignore anchors
18+
// https://github.com/facebook/docusaurus/issues/8883#issuecomment-1516328368
19+
const BannerContainerId = '__docusaurus-base-url-issue-banner-container';
20+
const BannerId = '__docusaurus-base-url-issue-banner';
2121
const SuggestionContainerId =
22-
'docusaurus-base-url-issue-banner-suggestion-container';
22+
'__docusaurus-base-url-issue-banner-suggestion-container';
2323

2424
const InsertBannerWindowAttribute = '__DOCUSAURUS_INSERT_BASEURL_BANNER';
2525

‎packages/docusaurus/src/client/BaseUrlIssueBanner/styles.module.css

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
* LICENSE file in the root directory of this source tree.
66
*/
77

8-
:global(#docusaurus-base-url-issue-banner-container) {
8+
:global(#__docusaurus-base-url-issue-banner-container) {
99
display: none;
1010
}

0 commit comments

Comments
 (0)
Please sign in to comment.