Skip to main content

​
FileBasedNavigationGenerator

Generates navigation structure for Mintlify documentation from existing MDX files.

​
Syntax

public class FileBasedNavigationGenerator

​
Inheritance

​
Constructors

​
FileBasedNavigationGenerator

public FileBasedNavigationGenerator(MintlifyOptions options)
Initializes a new instance of the FileBasedNavigationGenerator class.

​
Parameters

​
Methods

​
GenerateConfigOnlyAsync

public Task GenerateConfigOnlyAsync()
Generates the complete configuration only (docs.json) without building.

​
Returns

Task A task representing the asynchronous operation.

​
GenerateNavigationAsync

public Task<List<GroupConfig>> GenerateNavigationAsync()
Generates the navigation structure for the documentation from existing files.

​
Returns

Task<List<GroupConfig>> The navigation structure.

​
Remarks

This class creates a hierarchical navigation structure by scanning existing MDX files and parsing their frontmatter to extract title and icon information.
⌘I