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.
Realm indexes your Markdown, API descriptions, and code samples during each build. You choose the search engine and tune what the index includes.
- Search - How Realm processes your content and serves search results
- Search configuration - Choose a search engine, add facets, and exclude content from the index
- Search API - Query the search index from your own applications
Realm generates sitemaps, canonical URLs, and structured metadata for every page. You control titles, descriptions, and indexing behavior per page or across the site.
- SEO in Realm - How Realm builds pages that search engines can read and rank
- SEO configuration - Set metadata, sitemaps, and indexing rules for the site
- x-seo extension - Set SEO metadata on API documentation pages
- Make docs AI ready - Serve your documentation to AI assistants and agents
- Build navigation - Help readers find content after they arrive