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
- analytics
- auth
- copyCodeSnippet
- disableImagesOptimization
- disableLastModified
- disableLinkPrefetching
- editPage
- enableToc - deprecated in favor of
toc - envVariablesAllowedClientSide
- footer
- licenseKey
- linkChecker
- login
- logo
- meta - deprecated in favor of
seo - nav
- oasDefinitions
- postBodyScripts
- scripts
- seo
- showNextButton
- showPrevButton
- stylesheets
- toc
- tocMaxDepth - deprecated in favor of
toc
Example siteConfig.yaml file
seo:
title: Redocly Portal Example
description: The best API documentation generator ever.
siteUrl: https://portal-demo.redoc.ly
logo:
image: ./images/logo.png
altText: Portal logo
toc:
enable: true
disableLastModified: true
showPrevButton: true
disableImagesOptimization: true
oasDefinitions:
petstore: ./docs/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://redocly.com/docs-legacy/developer-portal/introduction/'
- search: true
footer:
copyrightText: Copyright © Redocly Portal Example
columns:
- group: Legal
items:
- label: Terms of Use
href: 'https://redocly.com/subscription-agreement/'
external: true
- label: Privacy Notice
href: 'https://redocly.com/privacy-policy/'
- group: Support
items:
- label: FAQ
page: faq.md
- label: Contact us
page: contact.mdx