Last updated

Organize your portal content

No new signups

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.

You may create different types of files depending on your needs.

Every developer portal project must have these files, which you edit for customization and configuration purposes:

  • or
  • siteConfig.yaml
  • sidebars.yaml
  • theme.ts
  • favicon.png

To create content for your developer portal, you can use:

URL routes

The folder and filename determine the URL route, so be deliberate with your naming.

The public folder name is reserved at the top-level of the portal project structure. You should not use it in the root directory of your portal, but it can be used in subdirectories.

The special or name is not included in the URL route. For example, if your base URL is, and you place in your project root, the contents would be accessed at

If you place inside of a guides folder, you would access that content at

On the other hand, if you name the file anything else, such as, and place it in the guides folder, it would be accessed at

Note that the .md and .md file extensions are never included in the URL route.

Developer portal structure

Here is an example structure of a developer portal project.

├── ./
├── ./
├── ./
├── ./favicon.png
├── ./images
│   ├── ./images/book-management.svg
│   ├── ./images/external-link-dark.svg
│   ├── ./images/found-or-private.svg
│   ├── ./images/icon1.png
│   ├── ./images/icon3.png
│   ├── ./images/launch-fast.svg
│   ├── ./images/logo.png
│   └── ./images/logo.svg
├── ./
├── ./openapi
│   └── ./openapi/petstore.yaml
├── ./package.json
├── ./
├── ./sidebars.yaml
├── ./siteConfig.yaml
├── ./theme.ts
├── ./developer-portal
│   ├── ./developer-portal/
│   ├── ./developer-portal/
│   ├── ./developer-portal/
│   ├── ./developer-portal/
│   ├── ./developer-portal/
│   ├── ./developer-portal/
│   ├── ./developer-portal/
│   ├── ./developer-portal/
│   ├── ./developer-portal/
│   └── ./developer-portal/
└── ./yarn.lock

In this example, most of our content is organized into the developer-portal folder.

The more content you create, the more you may want to organize it into sub-folders. It's a good practice to separate content by type (e.g. images in one folder, text in another). You can also categorize your content by topic into sub-folders, and create reusable Markdown snippets for single-source authoring.

To help your readers access and find the content faster, set up a sidebar for your portal.

Use the static folder to add assets

In some cases, you may want to host file types other than Markdown in your portal - for example, images, PDF documents, or scripts - and reference them as additional resources in your portal pages.

For this purpose, Redocly Developer portal supports a special folder called static. This folder must be in the root of the developer portal project, and its name must be static without any additional characters.

If it doesn't already exist in your portal project, create it manually before adding any assets into it. The static folder can contain any number of sub-folders, so you can organize assets by type or any other desired criteria.

All files placed into the static folder are served directly from the project root. This allows you to dynamically reference them with absolute links. For example, if you had a file ./static/image.png, you would link to it with


Any files (images, Markdown pages...) that you reference in the front matter of MD(X) pages are automatically copied to the static folder during the portal build. This happens even if you haven't manually created the static folder, and doesn't affect any of the manually added assets (if they exist).

Any MD(X) page in your Developer portal can contain links to other pages. When linking pages, make sure to use the correct path to the MD(X) file you want to link to.

Starting with the version 1.0.0-beta.115, the Developer portal supports absolute links from the root of the project (relative links have been supported since the first release).

If your MD(X) pages contain headings, you can link directly to a specific heading by its name instead of linking to the whole page. This is done by appending a fragment identifier (named anchor) to the file name. Heading names are case-insensitive, but you must replace spaces and any other special symbols in them with hyphens.

[Example named anchor](/guides/

Exclude pages from portal builds


Page exclusion is supported starting with version 1.0.0-beta.110 of the Developer portal.

In some cases, you may want to exclude specific pages from portal builds without removing the source files from your project. You can achieve this in either of the following two ways:

  • Add exclude: true to the front matter of the page you want to exclude. This front matter option is supported in MD and in MDX files.

  • Rename the page source file so that its file name starts with an underscore (_). For example, to exclude the file from the build, you would rename it to

To prevent broken links or potential build failures, make sure to remove any entries for the excluded page from your sidebars.yaml file. If other MD or MDX pages have links pointing to the excluded page, those links should be modified or removed prior to building the portal.

Exclude the file

If your developer portal project has a file in the top-level (root) folder, this file is automatically excluded from builds. File name matching is case-insensitive ( is treated the same as

If you have files in other folders and want to exclude them from builds, you must either change their file name to start with an underscore, or add the exclude: true front matter option. Automatic exclusion applies only when the file is in the root folder of the project.

Exclude folders from portal builds


Folder exclusion is supported starting with version 1.1.0-beta.114 of the Developer portal.

In case you want to exclude entire folder from portal builds you can rename the folder so that its name starts with an underscore (_). For example, to exclude the legacy folder from the build, you would rename it to _legacy.