Training program

This interactive training program is designed to help you understand how to create and edit content using Redocly's developer portal. It's a great companion to our developer portal docs.

Spend between an hour and a day playing with the most commonly utilized features.

Prerequisites

• Basic Git and markdown knowledge
• Node and yarn installed
• A text editor or IDE (we like VS Code)
• Setup the developer portal

Training exercises

Follow the training exercises sequentially. Or cherry-pick them independently if you're limited on time.

• Plain markdown pages
• Changing the url paths
• Markdown with a mermaid diagram
• The page table of contents
• Adding a page to the sidebar navigation
• Disabling the search box
• Changing nav and footer links
• Change your logo
• Change metadata
• Change your colors
• Change your typography
• Enable Google Analytics
• Modify the homepage
• Modify the OAS definitions
• Adding a response object to an MDX page
• Upgrade to a different version of the developer portal

Upon completion, you may have questions, or you may be ready to start building your content out. Learn how to deploy the developer portal to our global CDN or contact us about purchasing an enterprise license key.

Asking for help

Don't be shy... we're here to help.