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

Generate WebSite structured data in home page #2760

Closed
xuhdev opened this issue Oct 27, 2024 · 0 comments
Closed

Generate WebSite structured data in home page #2760

xuhdev opened this issue Oct 27, 2024 · 0 comments
Labels
enhancement Improved functionality

Comments

@xuhdev
Copy link
Contributor

xuhdev commented Oct 27, 2024

Search Terms

structured data, search engine

Problem

Google primarily uses the WebSite structured data to determine the name of the site shown in search results:

To indicate your site name preference, add WebSite structured data to your home page. Our site name system will also consider content in og:site_name, <title>, heading elements, and other text on a home page. However, WebSite structured data is most important, if you want to specify a preference.

Without a WebSite structured data, often the result is only a URL, not the name of the site. See a complaint.

See an example from searching one of the project that I maintain:

image

Compared with a typedoc result:

image

Note the text above the URL: One is the domain name of the site, one is the name of the site.

Search results from typedoc.org do show TypeDoc because the home page (not generated from typedoc) fills the og:site_name field: <meta property="og:site_name" content="TypeDoc Documentation Generator" />

Suggested Solution

Add a WebSite structured data to the home page of generated doc.

@xuhdev xuhdev added the enhancement Improved functionality label Oct 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality
Projects
None yet
Development

No branches or pull requests

1 participant