Skip to main content

Folder Tree Settings

Apidog provides a left-side folder tree setting feature for API documentation, allowing you to customize the style and layout according to your needs.

tip

Apidog version >=2.6.6 is required for this setting.

How to Access the Folder Tree Settings?

Clicking on the folder you want to modify within Apidog will take you to the folder tree settings, where you can customize a specific folder style.

Apidog Share docs - Accessing Settings

Folder Tree Display Style

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

Apidog Share Split - General Folder Display Mode

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

Apidog Share Split - Module Title Display Mode

Go to the Subfolder: When a folder contains extensive content, you can use this style. Clicking on the folder will navigate to a sub-page focused on the current folder's content.

Apidog Share Split - Go to the Subfolder Display Mode

Default to Expand/Collapse the Folder

Apidog Share Split - Default Expanded Folder

  • Global Automatic: This is the default option, which automatically adjusts the expansion or collapse of folders based on the number of items they contain, ensuring a rich left-side folder tree when the document is opened.

    Apidog Share Split - Default Expanded Folder

  • Manual Setting: With this option enabled, you can configure which folder should expand or collapse by default according to your preferences.

    Apidog Share Split - Manual Setting

Folder Contents Displaying Setting

Custom Content: When you click on the folder, it will show the text content that you have personalized by default. This text can serve as an introductory message or provide a brief overview of the folder's contents.

Apidog Share Split - Custom Content Displaying Setting

Sub-list: Clicking on the folder will display an index of the content within that folder, helping readers quickly understand the content.

Apidog Share Split - Sub-list Displaying Setting

Hide: Clicking on the folder will only expand or collapse the folder without displaying any content.