Definition
Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.CoreSyntax
Summary
Defines a renderer for documentation output generation.Remarks
Implementations of this interface generate specific output formats (Markdown, JSON, YAML, etc.) from the documentation model after all transformations have been applied.Methods
RenderAsync Abstract
Renders the documentation assembly to the output path specified in the project context.Syntax
Parameters
Returns
Type:System.Threading.Tasks.Task
A task representing the asynchronous rendering operation.
Remarks
When model is null, the renderer should skip API reference generation but still process any other operations like navigation file merging (e.g., combining DocumentationReferences). Renderers that support navigation combining (e.g., Mintlify) should access Context.DocumentationReferences and combine navigation before saving their configuration.RenderPlaceholdersAsync Abstract
Renders placeholder conceptual content files for the documentation assembly.Syntax
Parameters
Returns
Type:System.Threading.Tasks.Task
A task representing the asynchronous placeholder rendering operation.