We use cookies for analytics and to serve ads. Accept to enable Google Analytics and AdSense. You can decline to stay opt-out.
Doc search portals with WebSite + SearchResultsPage context, FAQs, and breadcrumb navigation.
Declares the docs site and connects the search action.
Labels the page as a search results surface within docs.
Answers how indexing works, what’s included, and freshness.
Provides navigation context to the search page.
Ensure every applicable required property is present in your implementation. Nested props reference their parent objects (for example, `offers.priceCurrency`).
Paste as a single script tag. Keep product details, offer data, shipping/returns, and FAQ answers in sync with the page.
[
{
"@context": "https://schema.org",
"@type": "WebSite",
"@id": "https://www.example.com/docs#website",
"name": "Example Docs",
"url": "https://www.example.com/docs",
"potentialAction": {
"@type": "SearchAction",
"target": "https://www.example.com/docs/search?q={search_term_string}",
"query-input": "required name=search_term_string"
}
},
{
"@context": "https://schema.org",
"@type": "SearchResultsPage",
"@id": "https://www.example.com/docs/search#page",
"name": "Search Docs",
"description": "Search API references, guides, and tutorials.",
"url": "https://www.example.com/docs/search"
},
{
"@context": "https://schema.org",
"@type": "FAQPage",
"mainEntity": [
{
"@type": "Question",
"name": "What does the search index include?",
"acceptedAnswer": {
"@type": "Answer",
"text": "All public API reference, tutorials, changelog entries, and guides are indexed."
}
},
{
"@type": "Question",
"name": "How fresh are the results?",
"acceptedAnswer": {
"@type": "Answer",
"text": "Docs are reindexed hourly. Newly published pages appear within 60 minutes."
}
},
{
"@type": "Question",
"name": "Do you support operators or filters?",
"acceptedAnswer": {
"@type": "Answer",
"text": "Use filters in the UI for product area, version, and date. Boolean operators are not supported."
}
}
]
},
{
"@context": "https://schema.org",
"@type": "BreadcrumbList",
"itemListElement": [
{ "@type": "ListItem", "position": 1, "name": "Home", "item": "https://www.example.com" },
{ "@type": "ListItem", "position": 2, "name": "Docs", "item": "https://www.example.com/docs" },
{ "@type": "ListItem", "position": 3, "name": "Search", "item": "https://www.example.com/docs/search" }
]
}
]Yes. WebSite defines the docs domain and search action; SearchResultsPage labels the results page itself.
If you show a default query, ensure the on-page content matches what is returned and align JSON-LD URLs to the visible page.