Build a developer portal.
The Redocly developer portal enables you to:
- Create, edit, and manage a significant number of APIs.
- Write contextual documentation in markdown (or MDX).
- Integrate interactive API samples right into the contextual descriptions.
- Generate high-quality API reference pages.
- Style and theme it to match your brand guidelines.
- Control the navbar, footer and sidebar structure and contents.
- Diagram concepts using docs-like-code integrations.
- Extend functionality with custom components.
- Restrict access to portal content for specific groups of users.
This guide includes the following pages:
- Introduction (this page) – familiarizes with the Developer Portal's main features and its documentation.
- Installation – lists steps to install and run the Developer Portal.
- Configuration – describes the main configuration files to customize and configure your Developer Portal.
- Navbars and footers – describes how to configure navbars and footers within the
- Sidebar navigation – describes how to configure the sidebar navigation within the
- Themes – describes how to style your portal within the
Creating content – describes how to create and manage your content.
- Markdown – demonstrates using GitHub-flavored markdown.
- MDX – demonstrates using React components within markdown.
- Page table of contents – show or hide a page table of contents.
- Diagrams – demonstrates making mermaid diagrams.
- API reference docs – how to integrate API reference docs.
- React components – developing custom React components to extend functionality.
Before you start working with Redocly Portal, we recommend getting familiar with the following terms and definitions:
- OpenAPI Specification (formerly Swagger Specification) – an API description format for REST APIs (abbreviated as OAS or OAS3).
- API documentation portal – a place that provides all necessary documentation related to the usage and integration of an API.
- Single source of truth – a practice of structuring the information models and associated data schema such that every data element is mastered (or edited) in only one place.
- Markdown – an easy-to-read/write plain text format that can be converted to HTML and other formats. Files have extension
- MDX – MDX allows you to use markdown and React components together. Files have extension