Organizing files

This page describes the file types used in Redocly Portal and their organization specifics.

When you create new content, start by creating a file within a folder. For details on file types used in Redocly Portal, see Configuration.

Files organization sample

Your files should be organized into folders. The folder naming is reflected in the URL path.

├── ./README.md
├── ./contact.mdx
├── ./faq.md
├── ./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
├── ./index.mdx
├── ./openapi
│   └── ./openapi/petstore.yaml
├── ./package.json
├── ./reference.page.yaml
├── ./sidebars.yaml
├── ./siteConfig.yaml
├── ./theme.ts
├── ./using-redocly
│   ├── ./using-redocly/creating-files.md
│   ├── ./using-redocly/development-tips.md
│   ├── ./using-redocly/footer-navigation.md
│   ├── ./using-redocly/installation.md
│   ├── ./using-redocly/introduction.md
│   ├── ./using-redocly/markdown-extensions.mdx
│   ├── ./using-redocly/markdown.md
│   ├── ./using-redocly/quickstart.md
│   ├── ./using-redocly/redoc-integration.md
│   ├── ./using-redocly/sidebar-nav.md
│   └── ./using-redocly/top-navigation.md
└── ./yarn.lock

In this example, most of my content is organized into the using-redocly folder.

The more content you create, the more you may want to organize it into more sub-folders.