You can use the Redocly editor to customize your developer portal by adding Markdown documents and updating the side navigation. You can also update styles by adding a styles.css file and reuse content by adding partial Markdown files.
This welcome document will guide you through what you can alter in the Markdown documents.
Check out the Config file documentation for more information about the redocly.yaml file for even more ways you can customize your developer portal including adding the following:
- RBAC configurations
- redirects
- custom themes
- API catalog
- search
- scripts, links, and SEO
- and more
Adding Markdown documents means you can write use cases, step-by-step tutorials, or conceptual content that you can then include with your API reference pages. We have also integrated Markdoc and Mermaid, which provide you additional formatting options for your Markdown.
Our portal uses Markdoc tags to add custom components to the CommonMark Markdown specification.
These tags extend the limited formatting ability of standard Markdown content.
We have added the following tags:
Our integration with Markdoc also means you can add your own custom tags.
Admonitions are helpful for calling your users' attention to a specific piece of information as a warning, informational note, or an indication of success. The following are examples of how you could use the admonitions we have provided; however, they can be customized by changing the names or even the background color in your styles document.
This is a Warning message
This is a Success message
This is an Info message
This is a Danger message