3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-30 02:37:59 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix(theme): add __ prefix to technical anchors, search crawlers (Algolia) should ignore them (#8909)

Browse source
This commit is contained in:
Sébastien Lorber 2023-04-20 16:39:50 +02:00 • committed by GitHub
parent f154b2f870
commit d220f481a7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 22 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

File diff suppressed because one or more lines are too long

2
packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/date-matter/index.html generated
View file

File diff suppressed because one or more lines are too long

2
packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/heading-as-title/index.html generated
View file

File diff suppressed because one or more lines are too long

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

File diff suppressed because one or more lines are too long

2
packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/mdx-blog-post/index.html generated
View file

File diff suppressed because one or more lines are too long

2
packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/mdx-require-blog-post/index.html generated
View file

File diff suppressed because one or more lines are too long

2
packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/simple/slug/index.html generated
View file

File diff suppressed because one or more lines are too long

2
packages/docusaurus-plugin-content-blog/src/__tests__/__fixtures__/website/build-snap/blog/unlisted/index.html generated
View file

File diff suppressed because one or more lines are too long

5
packages/docusaurus-theme-common/src/utils/skipToContentUtils.tsx
View file

@ -14,8 +14,11 @@ import {useLocationChange} from './useLocationChange';
* The id of the element that should become focused on a page * The id of the element that should become focused on a page
* that does not have a <main> html tag. * that does not have a <main> html tag.
* Focusing the Docusaurus Layout children is a reasonable fallback. * 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. * Returns the skip to content element to focus when the link is clicked.

5
packages/docusaurus-utils-common/src/index.ts
View file

@ -5,7 +5,10 @@
* LICENSE file in the root directory of this source tree. * 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 { export {
default as applyTrailingSlash, default as applyTrailingSlash,
type ApplyTrailingSlashParams, type ApplyTrailingSlashParams,

10
packages/docusaurus/src/client/BaseUrlIssueBanner/index.tsx
View file

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

2
packages/docusaurus/src/client/BaseUrlIssueBanner/styles.module.css
View file

@ -5,6 +5,6 @@
* LICENSE file in the root directory of this source tree. * 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; display: none;
} }