{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs-realm.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"redocly_category":"Realm","type":"markdown"},"seo":{"title":"Tune search and SEO","description":"OpenAPI-generated documentation tool with 24k+ stars on Github - make APIs your company's superpower.","siteUrl":"https://redocly.com","image":"/assets/redocly-card.f670aae34a39545a5ea633a540cb3a4a333a1f23bb2ed3c4a1b17a5fbcf0ac85.db81178d.png","lang":"en-US"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"tune-search-and-seo","__idx":0},"children":["Tune search and SEO"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Readers find your documentation in two ways: they search inside your site, or a search engine sends them to a page."," ","Realm supports both paths."," ","It builds a search index from your content at build time, and it generates the metadata, sitemaps, and page structure that search engines read."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"search-inside-your-site","__idx":1},"children":["Search inside your site"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Realm indexes your Markdown, API descriptions, and code samples during each build."," ","You choose the search engine and tune what the index includes."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/navigation/search"},"children":["Search"]}]}," - How Realm processes your content and serves search results"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/config/search"},"children":["Search configuration"]}]}," - Choose a search engine, add facets, and exclude content from the index"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/customization/search-api/openapi"},"children":["Search API"]}]}," - Query the search index from your own applications"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"search-engines-and-seo","__idx":2},"children":["Search engines and SEO"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Realm generates sitemaps, canonical URLs, and structured metadata for every page."," ","You control titles, descriptions, and indexing behavior per page or across the site."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/content/realm-seo"},"children":["SEO in Realm"]}]}," - How Realm builds pages that search engines can read and rank"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/config/seo"},"children":["SEO configuration"]}]}," - Set metadata, sitemaps, and indexing rules for the site"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/content/api-docs/openapi-extensions/x-seo"},"children":["x-seo extension"]}]}," - Set SEO metadata on API documentation pages"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":3},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/ai-ready"},"children":["Make docs AI ready"]}]}," - Serve your documentation to AI assistants and agents"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/navigation"},"children":["Build navigation"]}]}," - Help readers find content after they arrive"]}]}]},"headings":[{"value":"Tune search and SEO","id":"tune-search-and-seo","depth":1},{"value":"Search inside your site","id":"search-inside-your-site","depth":2},{"value":"Search engines and SEO","id":"search-engines-and-seo","depth":2},{"value":"Resources","id":"resources","depth":2}],"frontmatter":{"seo":{"title":"Tune search and SEO"}},"lastModified":"2026-08-26T22:04:40.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/realm/search-and-seo","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}