Portal guides
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.
Learn how to work with the Developer portal.
Portal management
Organize files
How to organize your portal content
Update the portal
How to upgrade the Developer portal to the latest version
Integrate Reference docs
How to integrate API reference docs into your portal
Use the API catalog
How to integrate files from Redocly API registry into your portal
Embed the portal into a website
How to use a proxy to embed the Developer portal into a website
Restart portal builds
How to restart a Developer portal build in Workflows
Portal content
Supported Markdown features
List of special Markdown features supported in the portal
Reuse content
How to reuse and single-source content with Markdown snippets
Insert Mermaid diagrams
How to add Mermaid diagrams to your pages
Create step-by-step guides
How to create interactive API guides
Set up portal redirects
How to set up 301 redirects in your portal
Customize response headers
How to configure custom response headers for hosted portals
Document microservices
How to document microservices APIs with the Developer portal
Customization
Customize portal navigation
How to customize portal navbars and footers
Configure environment variables
How to use environment variables in the portal
Built-in environment variables
List of built-in environment variables
Environment variable files
How to create environment variable files
Add the table of contents
How to add a table of contents to a page
Custom 404 page
How to create a custom 404 page for your portal
Reference hooks
How to use hooks in Reference docs integrated into the portal