redocly.yaml

seo:
  title: Redocly
  description: OpenAPI-generated documentation tool with 24k+ stars on Github - make APIs your company's superpower.
  siteUrl: https://redocly.com
  image: ./images/redocly-card.png
  lang: en-US

apiFunctions:
  folders:
    - /@api
    - /blog
    - /docs/changelog

redirects:
  $ref: redirects.yaml

ignore:
  - '.github'
  - 'learn/arazzo/_filesets/**'
  - '**/code-walkthrough-files/**'
  - docs/realm/.templates


markdown:
  partialsFolders:
    - 'docs-legacy/_snippets'
    - 'docs/_partials'
    - 'docs/realm/_partials'
scripts:
  head:
    - src: '@theme/color-mode-hack.js'
analytics:
  gtm:
    trackingId: GTM-KVV53WR
logo:
  image: ./images/redocly-white-logo.svg
  link: /
  altText: Redocly logo
userMenu:
  hideLoginButton: true
breadcrumbs:
  hide: true
feedback:
  type: mood
navigation:
  previousButton:
    hide: true
navbar:
  items:
    - group: Products
      menuStyle: drilldown
      items:
        - separator: Products
        - label: Reunite
          page: ./pages/reunite/reunite.page.tsx
          icon: ./images/icons/reunite.svg
        - label: Realm
          page: ./pages/realm/realm.page.tsx
          icon: ./images/icons/realm.svg
        - label: Revel
          page: ./pages/revel/revel.page.tsx
          icon: ./images/icons/revel.svg
        - label: Redoc
          page: ./pages/redoc/redoc.page.tsx
          icon: ./images/icons/redoc.svg
        - label: Reef
          page: ./pages/reef/reef.page.tsx
          icon: ./images/icons/reef.svg
        - label: Respect Monitoring
          page: ./pages/respect/respect.page.tsx
          icon: ./images/icons/respect.svg
        - separator: Open Source
        - label: Redoc
          page: ./pages/redoc/redoc.page.tsx
        - label: Redocly CLI
          page: ./pages/redocly-cli/redocly-cli.page.tsx
        - label: Respect
          href: /respect-cli

    - label: Docs
      page: ./docs/index.md
    - label: Learn
      page: ./pages/learning-center/learn.page.tsx
    - label: Customers
      page: ./pages/customers/customers.page.tsx
    - label: Pricing
      page: ./pages/pricing/pricing.page.tsx
footer:
  copyrightText: © 2025 Redocly Inc. All rights reserved.
  logo:
    hide: true
  items:
    - group: Products
      items:
        - label: Redoc
          page: ./pages/redoc/redoc.page.tsx
        - label: Revel
          page: ./pages/revel/revel.page.tsx
        - label: Reef
          page: ./pages/reef/reef.page.tsx
        - label: Realm
          page: ./pages/realm/realm.page.tsx
        - label: Reunite
          page: ./pages/reunite/reunite.page.tsx
        - label: Respect Monitoring
          page: ./pages/respect/respect.page.tsx
        - label: Redocly CLI
          page: ./pages/redocly-cli/redocly-cli.page.tsx
        - label: Respect
          href: /respect-cli
    - group: Explore
      items:
        - label: Pricing
          page: ./pages/pricing/pricing.page.tsx
        - label: Pro
          page: ./pages/pro/pro.page.tsx
        - label: Enterprise
          page: ./pages/enterprise/enterprise.page.tsx
        - label: Enterprise Plus
          page: ./pages/enterprise-plus/enterprise-plus.page.tsx
        - label: Customers
          page: ./pages/customers/customers.page.tsx
        - label: About Us
          page: ./pages/about/about.page.tsx
        - label: Careers
          page: ./pages/careers/careers.page.tsx
        - label: Contact Sales
          page: ./pages/contact-sales/contact-sales.page.tsx
    - group: Resources
      items:
        - label: Docs
          page: ./docs/index.md
        - label: Blog
          page: ./blog/index.page.tsx
        - label: Webinars
          page: ./pages/webinars/webinars.page.tsx
        - label: Why Redocly
          page: ./blog/favorite-new-features.md
        - label: Docs-like-code
          page: ./pages/docs-like-code/docsLikeCode.page.tsx
        - label: OpenAPI Editor
          page: ./pages/editor/editor.page.tsx
          external: true
    - group: Tech & legal
      items:
        - label: Security
          page: ./pages/security/security.page.tsx
        - label: Tech Stack
          page: ./blog/tech-stack.md
        - label: Status
          href: https://status.redocly.com/
        - label: Terms
          page: ./pages/legal/subscription-agreement.md
        - label: SLA
          page: ./pages/legal/sla.md
        - label: DPA
          page: ./pages/legal/data-processing-addendum.md
        - label: Privacy Notice
          page: ./pages/legal/privacy-notice.md
    - group: Contact us
      items:
        - label: Contact Us
          page: ./pages/contact-us/contact-us.page.tsx

env:
  preview:
    sso:
      - REDOCLY
      - CORPORATE

responseHeaders:
  '**':
    - name: X-XSS-Protection
      value: '1;mode=block;'
    - name: X-Content-Type-Options
      value: nosniff
    - name: X-Frame-Options
      value: deny
    - name: Strict-Transport-Security
      value: max-age=31536000; includeSubDomains; preload
    - name: Content-Security-Policy
      value: "
        script-src 
          'self' 
          'report-sample'
          https://js.hsforms.net 
          http://js.hsforms.net 
          https://*.hs-scripts.com
          https://*.hs-banner.com
          https://*.hs-analytics.net
          https://*.hscollectedforms.net
          https://forms.hsforms.com  
          https://www.google.com/recaptcha/ 
          https://www.gstatic.com/recaptcha/
          https://www.googletagmanager.com
          https://cdn.usefathom.com
          https://www.clarity.ms
          https://scripts.clarity.ms
          https://js.hscollectedforms.net
          https://js.hs-analytics.net
          https://js.hs-banner.com
          https://cdn.jsdelivr.net
          'sha256-M28mypAFwwpIwIF9e1/A6867PQiwVvOrdqFSTFSa8/U=' 
          'sha256-Ed6Lei7deBSXT1iYYw0V36YZXaA4v7OsRknNjmNl/9c='
          'sha256-uDN+KkW4ljf+D4DbsWP5KpxyfG/7h+LNmZxMzbz/+1E='
          'sha256-9seBUu3uBabJT/26wJPQEjpi+FB2ayw9N8BnQJlh/ls='
          'sha256-mqxawUgIH8vW3/GxWmOFDp5zt8IejNl5rNH2j9PXF88='
          'sha256-wkSWDFufZapa7t3NvV+JhSRXHb/4CI3ZnaqCvg7byns='
          'sha256-Tq4uREmlYInMCBRtudvmIOCc+VdyPNg3t18I9xtvdgs=' 
          'sha256-/mLWo7as1uoH7YxKP28RczpTaAJYtZFOdU0Okz4RWRo=' 
          'sha256-vHWNkFcRXsOiOWmmubySLtLeZ3xAubNJpC7UdmQgSQU=' 
          'sha256-FHfozmosNdt5yUG9l8OmVM1S/oTxw2TNWHPejSjEr58='
          'sha256-2VNfiq6Um2ua9MLfzend4JESqZeD1VSgkWvUrPvrlZE='
          'sha256-6Z9XwT1XsndpCDjoLgO3W3g2Dptc9WedO+nSCr9k3no='
          'sha256-+Ozb/ItuZAdaQgJd2RebN2rKWj1XkBuXVaV6/lT4Juo='
          'sha256-9qgU5FDrauEgF+e1iJWvsh46OwsIkNOLjkXggr/02jk='
          'sha256-v7ddZtWCUr5oF3kgrlEot4fG861CKDXUt0aTaNaIk6Q='
          'sha256-+t5Z3fJi7uJxARWEzFEVaSRgtaAn0r97XkxpJNbQiK0=';
        object-src 'none'; 
        base-uri 'self'; 
        connect-src 
          'self'
          https://webhook.frontapp.com
          https://j.clarity.ms/*
          https://api.github.com
          https://api.rebilly.com
          https://forms.hsforms.com
          https://forms.hscollectedforms.net
          https://*.google-analytics.com
          https://hubspot-forms-static-embed.s3.amazonaws.com
          https://v.clarity.ms/collect
          https://cdn.jsdelivr.net
          https://forms-na2.hscollectedforms.net
          https://forms-na2.hsforms.com;
        form-action 
          'self' 
          https://forms.hsforms.com
          https://webhook.frontapp.com 
          https:; 
        style-src 
          'self' 
          'unsafe-inline' 
          https://cdn.jsdelivr.net; 
        worker-src 
          'self' 
          blob:; 
        frame-src
          'self'
          https://www.google.com
          https://www.youtube.com
          https://forms-na2.hsforms.com/
          https://demo.arcade.software;
        child-src 
          'self' 
          blob:; 
        img-src 'self' data: https: blob:;"
      
  '/preview':
    - name: X-Frame-Options
      value: SAMEORIGIN
  '/preview/**':
    - name: X-Frame-Options
      value: SAMEORIGIN
  
  # Editor page requires 'unsafe-eval' for OpenAPI validation (AJV schema compilation)
  '/editor':
    - name: Content-Security-Policy
      value: "
        script-src 
          'self' 
          'unsafe-eval'
          https://cdn.jsdelivr.net
          https://www.googletagmanager.com
          'sha256-M28mypAFwwpIwIF9e1/A6867PQiwVvOrdqFSTFSa8/U='
          'sha256-Tq4uREmlYInMCBRtudvmIOCc+VdyPNg3t18I9xtvdgs='
          'sha256-vHWNkFcRXsOiOWmmubySLtLeZ3xAubNJpC7UdmQgSQU='
          'sha256-Ed6Lei7deBSXT1iYYw0V36YZXaA4v7OsRknNjmNl/9c=';
        object-src 'none'; 
        base-uri 'self'; 
        connect-src 'self' https://cdn.jsdelivr.net;
        style-src 'self' 'unsafe-inline' https://cdn.jsdelivr.net; 
        worker-src 'self' blob:; 
        child-src 'self' blob:; 
        img-src 'self' data: https: blob:;"

metadataGlobs:
  'blog/**':
    redocly_category: Blog
  'learn/**':
    redocly_category: Learn
  'docs/realm/**':
    redocly_category: Realm
  'docs/cli/**':
    redocly_category: Redocly CLI
  'docs/redoc/**':
    redocly_category: Redoc CE
  'docs/vscode/**':
    redocly_category: VS Code extension
  'docs-legacy/workflows/**':
    redocly_category: Workflows (Legacy)

openapi:
  excludeFromSearch: true

search:
  engine: typesense

links:
  - href: https://redocly.com/docs/changelog/feed.xml
    rel: alternate
    type: application/rss+xml
    title: Redocly Changelog RSS Feed
  - href: https://redocly.com/blog/feed.xml
    rel: alternate
    type: application/rss+xml
    title: Redocly Blog RSS Feed

banner:
  - content: ✨ **Announcement banners are here!** Display important updates and information at the top of your pages. [Learn more](/docs/realm/config/banner)
    target: '**'
    dismissible: true