Last updated 3 weeks ago

Configuration

After you install the developer portal template, you will have a variety of files and folders. A few files are used to configure and customize your developer 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. Change the contents of these files to configure look, feel, content and navigation.

File Description
index.mdx or index.md The home page of your developer portal. You'll need to replace the content.
To display a sidebar navigation menu, include it in the sidebars.yaml configuration.
siteConfig.yaml Set up your headers, footers, stylesheets, custom scripts, analytics, and more.
theme.ts Control the fonts and styles used throughout your developer portal.
sidebars.yaml Controls the sidebar navigation content.
favicon.png Displays 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 portal is a static site generator, and access controls must be implemented on the server-side.