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.

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

fix: use heading itself as anchor for better crawling #5481

Merged
merged 1 commit into from
Sep 3, 2021

Conversation

lex111
Copy link
Contributor

@lex111 lex111 commented Sep 3, 2021

Motivation

Resolves #5470

We have anchor link for headings without href attribute, which causes warning from Lighthouse https://developers.google.com/search/docs/advanced/guidelines/links-crawlable

But since we already use new scroll-margin-top, we can remove separate element for heading anchor, and instead just add this property on heading tag itself.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Preview + Lighthouse report

Related PRs

(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)

@lex111 lex111 added the pr: bug fix This PR fixes a bug in a past release. label Sep 3, 2021
@lex111 lex111 requested a review from slorber as a code owner September 3, 2021 10:25
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Sep 3, 2021
@slorber
Copy link
Collaborator

slorber commented Sep 3, 2021

Yes that makes sense thanks, also thought about removing this hidden element 👍

@netlify
Copy link

netlify bot commented Sep 3, 2021

✔️ [V2]

🔨 Explore the source changes: c8a75c9

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/6131f8291ee92400071f67d9

😎 Browse the preview: https://deploy-preview-5481--docusaurus-2.netlify.app

@github-actions
Copy link

github-actions bot commented Sep 3, 2021

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟢 Performance 98
🟢 Accessibility 98
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-5481--docusaurus-2.netlify.app/

@github-actions
Copy link

github-actions bot commented Sep 3, 2021

Size Change: -1.18 kB (0%)

Total Size: 826 kB

Filename Size Change
website/build/assets/css/styles.********.css 93.9 kB -51 B (0%)
website/build/blog/2017/12/14/introducing-docusaurus/index.html 67 kB -240 B (0%)
website/build/docs/index.html 44.6 kB -563 B (-1%)
website/build/docs/installation/index.html 52.8 kB -323 B (-1%)
ℹ️ View Unchanged
Filename Size
website/.docusaurus/globalData.json 36.7 kB
website/build/assets/js/main.********.js 414 kB
website/build/blog/index.html 38.1 kB
website/build/index.html 30.8 kB
website/build/tests/docs/index.html 25.4 kB
website/build/tests/docs/standalone/index.html 23 kB

compressed-size-action

@slorber slorber merged commit 8123271 into main Sep 3, 2021
@slorber slorber deleted the lex111/heading-anchor branch September 3, 2021 11:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: bug fix This PR fixes a bug in a past release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants