This page describes how to organize the files and folders and how to configure the look and feel of the Portal.
To start working with Redocly Portal, please get familiar with the following:
- The Markdown syntax. We recommend using Visual Studio Code for writing and maintaining your files.
- File management basics.
The following special folders will be created automatically within your project:
- images/ – you can keep your images in this folder.
- node_modules/ – do not remove or modify the contents of this folder. It contains the software library dependencies.
We recommend creating folders based on your content, and then organizing the content within one root folder:
Important: The folder naming influences the URL paths of the published website.
A regular markdown file ends with a
.md file extension. Utilize the regular markdown files when your content doesn't require any special components.
A markdown extension file ends with a
.mdx file extension. Learn more about using markdown extensions here.
The following files must be kept at the top level of the project structure. If needed, you can change the contents of these files to configure look and feel of the Portal.
||The home page of the Portal.|
||In this file, you can do the following:
||Controls the fonts and colors used throughout the Portal.|
||Controls the sidebar navigation among contents.|
||Displays the favicon.|
For more details, see Customizing Portal.
Also, you can include your OpenAPI .yaml or .json file directly in the Portal to be able to generate the API reference pages.
For more details, see Integrating API Reference.