Skip to main content

​
MintlifyNavigationGenerator

Generates Mintlify navigation configuration (docs.json) for the documentation site.

​
Syntax

public class MintlifyNavigationGenerator

​
Inheritance

​
Constructors

​
MintlifyNavigationGenerator

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

​
Parameters

​
Methods

​
GenerateApiReferenceGroup

public GroupConfig GenerateApiReferenceGroup(List<AssemblyXmlDocumentation> documentations)
Generates a single API Reference group configuration for updating existing docs.json navigation.

​
Parameters

​
Returns

GroupConfig A GroupConfig object representing the API Reference section.

​
GenerateGlobalNavigation

public DocsJsonConfig GenerateGlobalNavigation(List<AssemblyXmlDocumentation> documentations)
Generates global navigation configuration for multiple projects.

​
Parameters

​
Returns

DocsJsonConfig The global navigation configuration object.

​
GenerateNavigation

public DocsJsonConfig GenerateNavigation(AssemblyXmlDocumentation xmlDocumentation)
Generates navigation configuration for a single project.

​
Parameters

​
Returns

DocsJsonConfig The navigation configuration object.

​
GenerateSimpleNavigation

public DocsJsonConfig GenerateSimpleNavigation(string siteName, List<string> projects)
Generates a simple navigation structure for quick setup.

​
Parameters

  • siteName string: The name of the documentation site.
  • projects List<string>: The list of project names.

​
Returns

DocsJsonConfig A basic navigation configuration.

​
MergeWithExistingConfigAsync

public Task<DocsJsonConfig> MergeWithExistingConfigAsync(string configPath, DocsJsonConfig generatedConfig)
Merges the generated navigation configuration with existing docs.json configuration.

​
Parameters

  • configPath string: The path to the existing configuration file.
  • generatedConfig DocsJsonConfig: The newly generated configuration.

​
Returns

Task<DocsJsonConfig> The merged configuration preserving existing non-API settings.

​
WriteConfigurationAsync

public Task WriteConfigurationAsync(string configPath, DocsJsonConfig navigation)
Writes the navigation configuration to a docs.json file, preserving existing configuration.

​
Parameters

  • configPath string: The path to write the configuration file.
  • navigation DocsJsonConfig: The navigation configuration object.

​
Returns

Task A task representing the asynchronous operation.

​
WriteConfigurationInternalAsync

public Task WriteConfigurationInternalAsync(string configPath, DocsJsonConfig navigation)
Writes the navigation configuration to a docs.json file without merging with existing content.

​
Parameters

  • configPath string: The path to write the configuration file.
  • navigation DocsJsonConfig: The navigation configuration object.

​
Returns

Task A task representing the asynchronous operation.

​
Remarks

This class creates the navigation structure and configuration file for Mintlify, organizing the API documentation in a logical hierarchy that’s easy to browse. It supports both single-project and multi-project documentation sites.
⌘I