Folder Tree Settings

Customize the left-side folder tree in your API documentation to create an optimal navigation experience. Apidog provides flexible folder tree settings that allow you to control display styles, expansion behavior, and content presentation according to your documentation needs.

Accessing Folder Tree Settings

Click on any folder within Apidog to access its folder tree settings, where you can customize the folder's display style and behavior.

Folder Tree Display Styles

General Folder

By default, folders are displayed in a folder format. You can expand or collapse the folder by clicking on it.

Module Title

Displays as pure titles, used to differentiate between various modules.

Go to Subfolder

When a folder contains extensive content, use this style. Clicking the folder navigates to a sub-page focused on the current folder's content.

Apidog Share Split - Go to the Subfolder Display Mode

Expand/Collapse Behavior

Global Automatic

This is the default option, which automatically adjusts folder expansion or collapse based on the number of items they contain, ensuring a rich folder tree when the document opens.

Apidog Share Split - Default Expanded Folder

Manual Setting

With this option enabled, you can configure which folders should expand or collapse by default according to your preferences.

Folder Content Display Settings

Custom Content

When users click on the folder, it displays personalized text content. This text can serve as an introductory message or provide a brief overview of the folder's contents.

Sub-list

Clicking on the folder displays an index of the content within that folder, helping readers quickly understand what's inside.

Hide

Clicking on the folder only expands or collapses it without displaying any content.

Accessing Folder Tree Settings#

Folder Tree Display Styles#

General Folder#

Module Title#

Go to Subfolder#

Expand/Collapse Behavior#

Global Automatic#

Manual Setting#

Folder Content Display Settings#

Custom Content#

Sub-list#

Hide#