Last updated

Configuration files

No new signups

Looking for Realm documentation? These documentation are for our old developer portal. Realm users should contact their account manager for details of the early access documentation.

After you install the developer portal template, you have a variety of files and folders in your portal project. Some of those files are used to configure and customize your portal.


Do not remove or modify the contents of the node_modules folder. It contains the software library dependencies.

The following files must be kept at the top level of the project structure. You must not remove them, but you may change their contents to configure the appearance, content, and the navigation of your portal.

index.mdx or index.mdThe home page of your developer portal. You'll need to replace the default content with your own.
To display a navigation sidebar on the home page, you must include the page in the sidebars.yaml file.
siteConfig.yamlContains the main configuration options for navbars, footers, stylesheets, custom scripts, analytics, and more.
theme.tsControls the fonts, colors and styles used throughout your developer portal.
sidebars.yamlControls the portal sidebar content.
favicon.pngDisplays the favicon. Replace it with your favicon.

Access controls

Unless you are self-hosting, access controls are managed within our app as part of our CI/CD Workflows product.

Redocly developer portal is a static site generator, and access controls must be implemented on the server-side.