{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"front-matter-configuration-options","__idx":0},"children":["Front matter configuration options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add front matter to Markdown pages to configure page-specific options."," ","Front matter must appear at the beginning of a Markdown file in valid YAML format between triple-dashed lines (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["---"]},")."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Front matter options fall into two categories:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Options available ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["only"]}," in page front matter"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Options that ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["override"]}," global configurations from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"front-matter-only-options","__idx":1},"children":["Front matter-only options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These options are available exclusively in front matter:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["excludeFromSearch"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Exclude the page from search results (both AI search and keyword search), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["llms.txt"]},", and the sitemap when set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Search indexes are only built on the production branch."," ","Changes to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excludeFromSearch"]}," appear in search results after the next production build."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To exclude OpenAPI description files from search, see: ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/openapi"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["openapi"]}," configuration"]},"."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["sidebar"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sidebar to display for this page."," ","Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["path"]}," to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sidebars.yaml"]}," file, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sidebar:"]}," then ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["path: sidebars.yaml"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Realm deprecates the older form that sets the path as a string directly."," ","That form still works, and Realm logs a deprecation warning that names the file."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["slug"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string | [string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom URL path for this page, instead of the default path based on folder and file names."," ","Define multiple slugs to make content available at multiple URLs."," ","Slugs can contain multiple segments, for example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["'/custom-pages/page-1'"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["template"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Path to a custom template for the Markdown page."," ","Omit file extensions."," ","Use relative paths for local templates and absolute paths for templates from node modules."," ","Overrides a template assigned by ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/markdown#options"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["markdown.template"]}]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]},"."," ","See ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/customization/custom-page-templates"},"children":["Customize page templates"]}," for details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["navigation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/navigation#options-that-apply-to-front-matter-only"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]}," options"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customize the links and button labels of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nextButton"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["previousButton"]},"."," ","These options are available for front matter config only."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["keywords"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Curate search results for the page with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["includes"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excludes"]}," lists."," ","See ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/search#curate-search-results"},"children":["Curate search results"]},"."," ","Requires the Typesense search engine."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"options-that-override-global-configuration","__idx":2},"children":["Options that override global configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These options work in both front matter and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]},"."," ","When defined in front matter, they override the global configuration:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/banner"},"children":["banner"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure page-specific announcement banners."," ","When defined in front matter, banners automatically target the page where they're configured and take priority over global banners."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["target"]}," option is not needed for front matter banners."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/breadcrumbs"},"children":["breadcrumbs"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Toggle breadcrumbs display or prefix them with custom links."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/code-snippet"},"children":["codeSnippet"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure code snippet controls such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["copy"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["report"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expand"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["collapse"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/color-mode"},"children":["colorMode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Toggle color mode switcher display with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hide"]}," option."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/feedback"},"children":["feedback"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customize or hide the sentiment feedback form at the bottom of pages."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/footer"},"children":["footer"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Toggle footer display with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hide"]}," option (the only footer property available in front matter)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/markdown"},"children":["markdown"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customize element behavior and appearance, including ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/markdown#last-updated-object"},"children":["last updated"]},", ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/markdown#table-of-contents-object"},"children":["table of contents"]},", and ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/markdown#edit-page-object"},"children":["edit page"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/metadata"},"children":["metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Attach metadata to the page for catalogs, filtering, and search."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/navigation"},"children":["navigation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customize the behavior and appearance of the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Next page"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Previous page"]}," navigation buttons."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/navbar"},"children":["navbar"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Toggle navbar display with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hide"]}," option (the only navbar property available in front matter)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["rbac"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/access/rbac#team-to-role-map"},"children":["Map[string, string]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map of teams to roles."," ","Set access permissions for the page."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/redirects"},"children":["redirects"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map paths that should redirect to this page, each with an optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," (default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["301"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/search"},"children":["search"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customize the behavior and appearance of the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Search"]}," dialog."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/seo"},"children":["seo"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configure SEO information in the page's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<head>"]}," element."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/version-picker"},"children":["versionPicker"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set the visibility of the version picker."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":3},"children":["Examples"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-1-custom-url-and-page-template","__idx":4},"children":["Example 1: Custom URL and page template"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This configuration:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Creates two interchangeable URL paths: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/pricing"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/subscribe"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Uses a custom blog post template"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Hides the color mode switcher"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"---\nslug:\n  - /pricing\n  - /subscribe\ntemplate: './@theme/Templates/BlogPost'\ncolorMode:\n  hide: true\n---\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-2-seo-and-component-configuration","__idx":5},"children":["Example 2: SEO and component configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This configuration:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Prevents search engine indexing"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Hides the report button on code snippets"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Limits table of contents to h2 headers"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Adds a \"Home\" link to the page breadcrumbs"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"---\nseo:\n  meta:\n    - name: robots\n      content: noindex\ncodeSnippet:\n  report:\n    hide: true\nmarkdown:\n  toc:\n    depth: 2\nbreadcrumbs:\n  prefixItems:\n    - page: index.page.tsx\n      label: Home\n      labelTranslationKey: home.title\n---\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"best-practices","__idx":6},"children":["Best practices"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]}," for most configuration settings and use front matter only for page-specific overrides."]},{"$$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":"Link","attributes":{"href":"/docs/realm/customization/custom-page-templates"},"children":["Customize page templates"]}]}," - Create custom page templates to override default layouts and implement unique page designs"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config"},"children":["Configuration options"]}]}," - Complete configuration reference for the redocly.yaml file and project settings"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/seo#control-search-indexing"},"children":["Block search indexing"]}]}," - Use the noindex rule in front matter to control search engine indexing on specific pages"]}]}]},"frontmatter":{},"tagList":["table"],"title":"Front matter configuration options","lastModified":"2026-10-01T23:00:57.000Z"}