Skip to main content

​
MintlifyGenerator

Main generator for converting .NET XML documentation to Mintlify MDX format.

​
Syntax

public class MintlifyGenerator

​
Inheritance

​
Constructors

​
MintlifyGenerator

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

​
Parameters

​
Methods

​
GenerateAsync

public Task GenerateAsync(AssemblyXmlDocumentation xmlDocumentation)
Generates Mintlify documentation from XML documentation.

​
Parameters

​
Returns

Task A task representing the asynchronous operation.

​
GenerateAsync

public Task GenerateAsync(IEnumerable<AssemblyXmlDocumentation> documentations)
Generates documentation for multiple assemblies.

​
Parameters

​
Returns

Task A task representing the asynchronous operation.

​
Remarks

This class orchestrates the conversion process, coordinating between XML documentation parsing, type analysis, and MDX file generation. It handles the overall structure and organization of the generated documentation.
⌘I