Last updated 3 weeks ago

Developer portal configuration

The siteConfig.yaml file is the central place for configuring your developer portal. It contains a number of configuration options, either as standalone top-level items or divided into sections based on the functionality they control.

The order of sections and top-level options in the file is arbitrary - you can list them in any order you want. Pay attention to the indentation when modifying the file.

Supported configuration options

Example siteConfig.yaml file

meta:
  title: Redocly Portal Example
  description: The best API documentation generator ever.
  siteUrl: https://portal-demo.redoc.ly
logo: ./images/logo.png
enableToc: true
disableLastModified: true
showPrevButton: true
disableImagesOptimization: true
oasDefinitions:
  petstore: ./openapi/petstore.yaml
stylesheets:
  - 'https://fonts.googleapis.com/css?family=Roboto:300,400,600,700'
scripts:
  - ./static/intercom.js
nav:
  - label: Training exercises
    page: developer-portal/index.md
    external: true
  - label: External docs
    icon: ./images/redocly-icon-white.png
    href: 'https://docs.redoc.ly/developer-portal/introduction/'
  - search: true
footer:
  copyrightText: Copyright © Redocly Portal Example
  columns:
    - group: Legal
      items:
        - label: Terms of Use
          href: 'https://redoc.ly/subscription-agreement/'
          external: true
        - label: Privacy Notice
          href: 'https://redoc.ly/privacy-policy/'
    - group: Support
      items:
        - label: FAQ
          page: faq.md
        - label: Contact us
          page: contact.mdx