{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"build-navigation","__idx":0},"children":["Build navigation"]},{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Pro","Enterprise","Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Redocly offers comprehensive navigation customization to help users easily discover and navigate through your documentation."," ","From simple link organization to advanced multi-product sites, you can configure navigation elements to match your project's structure and branding needs."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"available-navigation-elements","__idx":1},"children":["Available navigation elements"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"core-navigation","__idx":2},"children":["Core navigation"]},{"$$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/config/navbar"},"children":["Navbar"]}]}," - Top navigation bar with links, groups, and dropdowns"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/sidebar"},"children":["Sidebar"]}]}," - Left navigation panel (configure content with ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/navigation/sidebars"},"children":["sidebars.yaml"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/navigation/navigation-tabs"},"children":["Navigation tabs"]}]}," - Second row of navigation that splits a sidebar into sections, each with its own tab"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/footer"},"children":["Footer"]}]}," - Bottom page footer with links and copyright information"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/search"},"children":["Search"]}]}," - Site-wide search functionality with faceting capabilities"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"page-navigation","__idx":3},"children":["Page navigation"]},{"$$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/config/navigation"},"children":["Navigation buttons"]}]}," - Previous/Next page navigation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/markdown#table-of-contents-object"},"children":["Table of Contents (TOC)"]}]}," - Page-level heading navigation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/breadcrumbs"},"children":["Breadcrumbs"]}]}," - Page hierarchy trail"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"advanced-navigation","__idx":4},"children":["Advanced navigation"]},{"$$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/config/products"},"children":["Multi-product picker"]}]}," - Switch between different product documentation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/version-picker"},"children":["Version picker"]}]}," - Navigate between documentation versions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/l10n"},"children":["Locale picker"]}]}," - Switch between localized content"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"quick-start-examples","__idx":5},"children":["Quick start examples"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"basic-site-navigation","__idx":6},"children":["Basic site navigation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For a simple documentation site with standard navigation:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"navbar:\n  items:\n    - page: index.md\n      label: Home\n    - page: docs/getting-started.md\n      label: Getting Started\n    - page: api-reference.md\n      label: API Reference\n\nfooter:\n  copyrightText: \"© 2024 Your Company. All rights reserved.\"\n  items:\n    - group: Documentation\n      items:\n        - page: docs/guides.md\n          label: Guides\n        - href: https://support.example.com\n          label: Support\n          external: true\n\nsearch:\n  engine: flexsearch\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"multi-product-site","__idx":7},"children":["Multi-product site"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For documentation covering multiple products or services:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"products:\n  - id: product-a\n    name: Product A\n    slug: /product-a/\n  - id: product-b\n    name: Product B\n    slug: /product-b/\n\nnavbar:\n  items:\n    - group: Products\n      items:\n        - page: product-a/index.md\n          label: Product A\n        - page: product-b/index.md\n          label: Product B\n    - page: support.md\n      label: Support\n\n# Hide sidebar on landing pages\nsidebar:\n  hide: true\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"enterprise-search-setup","__idx":8},"children":["Enterprise search setup"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For advanced search with faceting (Enterprise+ plans):"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"search:\n  engine: typesense\n  facets:\n    - name: Category\n      field: redocly_category\n      type: multi-select\n    - name: Product\n      field: product\n      type: multi-select\n    - name: Version\n      field: version\n      type: tags\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"navigation-patterns","__idx":9},"children":["Navigation patterns"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"landing-page-pattern","__idx":10},"children":["Landing page pattern"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For sites with a dedicated landing page, typically hide the sidebar on the landing page by not including it in a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sidebars.yaml"]}," file."," ","If you don't have a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sidebars.yaml"]}," file, you can exclude it in front matter."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In a Markdown file:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"index.md","header":{"title":"index.md","controls":{"copy":{}}},"source":"---\nsidebar:\n  hide: true\n---\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In a TSX file:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"tsx","data-title":"index.page.tsx","header":{"title":"index.page.tsx","controls":{"copy":{}}},"source":"export const frontmatter = {\n  sidebar: {\n    hide: true\n  }\n};\n","lang":"tsx"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"documentation-section-pattern","__idx":11},"children":["Documentation section pattern"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For traditional documentation with hierarchical navigation:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"treeview","header":{"controls":{"copy":{}}},"source":"docs/\n├── index.md              # Landing page\n├── getting-started/\n│   ├── index.md\n│   ├── installation.md\n│   └── sidebars.yaml     # Section-specific navigation\n├── guides/\n│   ├── index.md\n│   ├── advanced.md\n│   └── sidebars.yaml\n└── sidebars.yaml         # Main navigation\n","lang":"treeview"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"api-documentation-pattern","__idx":12},"children":["API documentation pattern"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For API-focused sites with reference and guides:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"navbar:\n  items:\n    - page: index.md\n      label: Overview\n    - page: guides/index.md\n      label: Guides\n    - group: API Reference\n      items:\n        - page: users-api.yaml\n          label: Users API\n        - page: orders-api.yaml\n          label: Orders API\n\ncatalogClassic:\n  enabled: true\n  title: API Catalog\n  slug: /apis/\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"configuration-tips","__idx":13},"children":["Configuration tips"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"responsive-navigation","__idx":14},"children":["Responsive navigation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All navigation elements are responsive by default."," ","For mobile-optimized experiences:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Keep navbar items concise (5-7 top-level items max)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use groups sparingly in navbar dropdowns"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Consider shorter labels for mobile: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label: API Ref"]}," instead of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label: API Reference"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"performance-considerations","__idx":15},"children":["Performance considerations"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Search facets"]},": More facets mean more processing - use only necessary facets"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sidebar depth"]},": Deep nesting can impact performance and UX"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["External links"]},": Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["external: true"]}," for links opening in new tabs"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"accessibility","__idx":16},"children":["Accessibility"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Always provide meaningful ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]}," values for screen readers"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use descriptive link text instead of \"click here\" or \"read more\""]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Maintain logical navigation hierarchy"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"localization-support","__idx":17},"children":["Localization support"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All navigation elements support localization through translation keys:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"navbar:\n  items:\n    - page: index.md\n      label: Home\n      labelTranslationKey: nav.home\n\nfooter:\n  items:\n    - group: Legal\n      groupTranslationKey: footer.legal\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/l10n"},"children":["localization configuration"]}," for complete setup details."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"need-help","__idx":18},"children":["Need help"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Getting Started"]},": Begin with the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/navbar"},"children":["navbar configuration"]}," and ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/navigation/sidebars"},"children":["sidebar setup"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Advanced Features"]},": Explore ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/products"},"children":["multi-product setup"]}," and ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/search"},"children":["search configuration"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom Styling"]},": See ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/branding"},"children":["branding options"]}," for visual customization"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":19},"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/config/front-matter-config"},"children":["Front matter configuration options"]}]}," - Page-specific navigation overrides"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/navigation/sidebars"},"children":["Configure sidebars"]}]}," - Complete sidebars.yaml syntax"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/branding"},"children":["Style your site"]}]}," - Visual customization of navigation elements"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/navigation/search"},"children":["Site search"]}]}," - Learn how Realm processes your content and serves search results"]}]}]},"frontmatter":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Pro","Enterprise","Enterprise+"],"markdown":{"toc":{"hide":true}}},"tagList":["configOptionRequirements"],"title":"Build navigation","lastModified":"2026-10-01T23:00:57.000Z"}