Structure File Reference

The structure.yaml defines the tab and subtab structure of your project, and maps tabs to content in specific subdirectories.

This document contains the reference documentation for the file.

For usage and examples, see tabs and sub-tabs.

Configuration Example

An example structure.yaml demonstrating the available configuration options.

tabs:
  - label: Home
    icon:
      set: lucide
      name: home
    subtabs:
      - label: Home
        path: /
  - label: Desktop
    subtabs:
      - label: Introduction
        path: /desktop/introduction/
      - label: Advanced
        path: /desktop/advanced/
  - label: Dashboard
    subtabs:
      - label: Introduction
        path: /dashboard/introduction/
      - label: Advanced
        path: /dashboard/advanced/
  - label: Changelog
    external: http://example.com/

Reference

Below are explanations of all the objects and their fields in the structure definition.

Tab object

The tab object requires

field description required? default
label The title of the tab true
subtabs List of sub-tabs in the tab (see below) true*
external LinkSections in the tab true*
icon Icon to display for the tab (see below) false

Note: You must either specify subtabs or external for a tab.

Sub-tab object

field description required? default
label The title of the section true
path Folder to include in the section. true
icon Icon to display for the subtab (see below) false

Icon object

The icon field expects an object with the following fields:

field description required? default
set Name of the icon set (either lucide or devicon) true
name The name of the icon in the set true

Was this page helpful?

On This Page