{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs-realm.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["configOptionRequirements"]},"redocly_category":"Realm","type":"markdown"},"seo":{"title":"SEO in Realm","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","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"seo-in-realm","__idx":0},"children":["SEO in Realm"]},{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"products":["Revel","Realm"],"plans":["Pro","Enterprise","Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Discover how Realm ensures that your published project works well with search engines and what you can do to further optimize your content."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"seo-automation","__idx":1},"children":["SEO automation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Realm's features automate many aspects of SEO:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Link validation"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Realm validates both your links and redirects as you add content to your project."," ","You can catch broken links and stale redirects early, and the built-in CI/CD jobs prevent projects with link errors from publishing."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Lazy-loading"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Images and heavy components like the Replay console are loaded only when needed, improving the speed with which pages load."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Site map generation"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/config/seo#generate-a-sitemap"},"children":["Configure ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["siteUrl"]}]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]}," and build your project."," ","After the build is finished, Realm automatically generates a sitemap for your project."," ","The sitemap is available at ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https:///sitemap.xml"]},"."," ","You can then submit it to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://search.google.com/search-console/"},"children":["Google Search Console"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Link canonicalization"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After you ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/config/seo#generate-a-sitemap"},"children":["configure ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["siteUrl"]}]},", Realm also adds a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[""]}," element to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[""]}," of each of your pages."," ","This element points to the page that represents the latest version of that content."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When your project contains versioned content, only the pages generated from files in the default version subfolder are marked as canonical."," ","If you later change the default version, Realm automatically moves the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[""]}," to the new default version pages."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"optimize-your-project-for-search-engines","__idx":2},"children":["Optimize your project for search engines"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the following strategies and techniques to boost the discoverability of your documentation both for external search engines, and internal search in Realm projects."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"build-a-pillar-structure-for-your-pages","__idx":3},"children":["Build a pillar structure for your pages"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Rather than a flat structure, consider grouping your content into related topics and placing them into separate folders."," ","Then dedicate one page to be the \"pillar\": an overview of content in the folder that links to each content file."," ","Finally, link back the content files to the pillar page."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This method reinforces the authority of the page over the given topic, and also makes your content easier to find."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart\n A[Git integrations\n index.md] -->\n B[GitHub\n github.md] -->\n A --> C[GitLab\n gitlab.md] -->\n A --> D[Azure DevOps\n azure.md] -->\n A --> E[BitBucket\n bitbucket.md] --> A\n","diagramHtml":"","diagramHtmlDark":""},"children":["flowchart\n A[Git integrations\n index.md] -->\n B[GitHub\n github.md] -->\n A --> C[GitLab\n gitlab.md] -->\n A --> D[Azure DevOps\n azure.md] -->\n A --> E[BitBucket\n bitbucket.md] --> A\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"add-unique-page-titles-and-descriptions","__idx":4},"children":["Add unique page titles and descriptions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use unique, descriptive titles."," ","Repeated titles like \"Overview\", \"Settings\", or \"Getting started\" can negatively affect search results and also become confusing for users and authors."," ","Instead, use product or feature names: \"Authentication overview\", \"RBAC settings\", \"Getting started in Reunite\"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"add-meta-tags","__idx":5},"children":["Add meta tags"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["HTML ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[""]}," tags describe your content for search engines."," ","The tags and their values affect how your project pages are indexed and displayed in the search results."," ","In Realm, you can set the values for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[""]}," tags under the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/config/seo"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["seo"]}," option"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]}," for the entire project"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["in the front matter of individual pages to override global configuration"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following options are available to configure in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["seo"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},": Add up to 150 characters to have a better control over the text snippet that appears in external search engines."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keywords"]},": While keywords lost their importance in SEO, you still can add them to your project."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["meta"]},": You can add additional meta tags to your project and individual pages."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Realm also provides options for social media sharing:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["image"]},": Add a path to an image you want to appear on social media link previews."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example of metadata on a blogpost page:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"---\nseo:\n title: SEO the API docs\n description: SEO is an excellent API marketing technique.\n keywords: 'seo, documentation, api'\n image: ./images/seo.jpg\n---\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"json-ld","__idx":6},"children":["JSON-LD"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Realm supports JSON-LD parameters in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]}," and in the front matter to add structured data to your project."," ","You can choose from among the schemas available on ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://schema.org/docs/schemas.html"},"children":["Schema.org"]}," that best describe your project or individual pages."," ","Structured data is essential for creation of rich snippets and improving the click-through rate of your project."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["jsonLd"]}," object can be used alongside other ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["seo"]}," options."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example of JSON-LD metadata on a blogpost page:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"---\nseo:\n jsonLd:\n \"@context\": https://schema.org\n \"@type\": BlogPosting\n author:\n - \"@type\": Person\n name: Adam Altman\n url: https://twitter.com/adamaltman\n headline: SEO the API docs\n---\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":7},"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/config/seo"},"children":["seo"]}]}," - Explore configuration options that optimize your content for search engines"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/config/front-matter-config"},"children":["Front matter configuration"]}]}," - Configure information for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[""]}," tag for specific pages"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://redocly.com/blog/seo-best-practices-documentation"},"children":["SEO best practices for documentation"]}]}," - Read Redocly's blog post about making your project work better with search engines"]}]}]},"headings":[{"value":"SEO in Realm","id":"seo-in-realm","depth":1},{"value":"SEO automation","id":"seo-automation","depth":2},{"value":"Optimize your project for search engines","id":"optimize-your-project-for-search-engines","depth":2},{"value":"Build a pillar structure for your pages","id":"build-a-pillar-structure-for-your-pages","depth":3},{"value":"Add unique page titles and descriptions","id":"add-unique-page-titles-and-descriptions","depth":3},{"value":"Add meta tags","id":"add-meta-tags","depth":3},{"value":"JSON-LD","id":"json-ld","depth":4},{"value":"Resources","id":"resources","depth":2}],"frontmatter":{"products":["Revel","Realm"],"plans":["Pro","Enterprise","Enterprise+"],"seo":{"title":"SEO in Realm"}},"lastModified":"2026-05-30T13:19:34.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/realm/content/realm-seo","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}