Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dotnetdocs.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Definition

Assembly: CloudNimble.DotNetDocs.Mintlify.dll Namespace: CloudNimble.DotNetDocs.Mintlify Inheritance: CloudNimble.DotNetDocs.Core.Renderers.MarkdownRendererBase

​
Syntax

CloudNimble.DotNetDocs.Mintlify.MintlifyRenderer

​
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

public MintlifyRenderer(CloudNimble.DotNetDocs.Core.ProjectContext context, Microsoft.Extensions.Options.IOptions<CloudNimble.DotNetDocs.Mintlify.MintlifyRendererOptions> options, Mintlify.Core.DocsJsonManager docsJsonManager)

​
Parameters

NameTypeDescription
contextCloudNimble.DotNetDocs.Core.ProjectContextThe project context.
optionsMicrosoft.Extensions.Options.IOptions<CloudNimble.DotNetDocs.Mintlify.MintlifyRendererOptions>The Mintlify renderer options.
docsJsonManagerMintlify.Core.DocsJsonManagerThe DocsJsonManager for navigation generation.

​
Methods

​
RenderAsync

Renders the documentation assembly to MDX files with optional docs.json generation.

​
Syntax

public System.Threading.Tasks.Task RenderAsync(CloudNimble.DotNetDocs.Core.DocAssembly model)

​
Parameters

NameTypeDescription
modelCloudNimble.DotNetDocs.Core.DocAssembly?The documentation assembly to render, or null for documentation-only mode.

​
Returns

Type: System.Threading.Tasks.Task A task representing the asynchronous rendering operation.

​
RenderPlaceholdersAsync

Renders placeholder conceptual content files for the documentation assembly.

​
Syntax

public System.Threading.Tasks.Task RenderPlaceholdersAsync(CloudNimble.DotNetDocs.Core.DocAssembly model)

​
Parameters

NameTypeDescription
modelCloudNimble.DotNetDocs.Core.DocAssemblyThe documentation assembly to generate placeholders for.

​
Returns

Type: System.Threading.Tasks.Task A task representing the asynchronous placeholder rendering operation.
  • CloudNimble.DotNetDocs.Core.IDocRenderer