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 title_meta handling in doc front matter #10879

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

MisterFISHUP
Copy link
Contributor

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

The title_meta field, as documented in the docs, should allow overriding frontMatter.title for SEO purposes. However, it doesn't work for doc pages, while it does work correctly for blog posts.

I tried to fix the issue in docs by following how it works for blog pages.

Related issues/PRs

#10586, #10878

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jan 29, 2025
Copy link

netlify bot commented Jan 29, 2025

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit c6c3cc6
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/679981a296fe680008b99ffa
😎 Deploy Preview https://deploy-preview-10879--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO Report
/ 🟠 71 🟢 98 🟢 96 🟢 100 Report
/docs/installation 🟠 51 🟢 97 🟢 100 🟢 100 Report
/docs/category/getting-started 🟠 73 🟢 100 🟢 100 🟠 86 Report
/blog 🟠 63 🟢 96 🟢 100 🟠 86 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 62 🟢 92 🟢 100 🟢 100 Report
/blog/tags/release 🟠 64 🟢 96 🟢 100 🟠 86 Report
/blog/tags 🟠 74 🟢 100 🟢 100 🟠 86 Report

Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feature has only be added to the blog plugin on purpose, as a blog-only temporary workaroud

For docs, it's not really needed: frontMatter.title is already enough for that purpose

See my comment here: #10586 (comment)

If you still think this feature needs to be added to the docs plugin, I'd really like to know why. Please give a concrete example where you couldn't find any alternative, and we'll consider it.


However you caught an interesting mistake: we implemented this for the blog plugin, but documented it in the docs plugin API ref 😅 The docs need to be fixed.

#10586

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants