Definition
Assembly: CloudNimble.DotNetDocs.Mintlify.dll Namespace: CloudNimble.DotNetDocs.Mintlify Inheritance: CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBaseSyntax
Summary
Renders documentation as MDX files with Mintlify frontmatter and navigation.Remarks
Generates structured MDX documentation with Mintlify-specific features including frontmatter with icons, tags, and SEO metadata. Optionally generates docs.json navigation configuration for Mintlify documentation sites.Constructors
.ctor
Initializes a new instance of the MintlifyRenderer class.Syntax
Parameters
Name | Type | Description |
---|---|---|
context | CloudNimble.DotNetDocs.Core.ProjectContext | The project context. |
options | Microsoft.Extensions.Options.IOptions<CloudNimble.DotNetDocs.Mintlify.MintlifyRendererOptions> | The Mintlify renderer options. |
docsJsonManager | Mintlify.Core.DocsJsonManager | The DocsJsonManager for navigation generation. |
Methods
RenderAsync
Renders the documentation assembly to MDX files with optional docs.json generation.Syntax
Parameters
Name | Type | Description |
---|---|---|
model | CloudNimble.DotNetDocs.Core.DocAssembly | The documentation assembly to render. |
Returns
Type:System.Threading.Tasks.Task
A task representing the asynchronous rendering operation.
Related APIs
- CloudNimble.DotNetDocs.Core.IDocRenderer