Definition

Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core

Syntax

CloudNimble.DotNetDocs.Core.IDocRenderer

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

Renders the documentation assembly to the output path specified in the project context.

Syntax

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

Parameters

NameTypeDescription
modelCloudNimble.DotNetDocs.Core.DocAssemblyThe documentation assembly to render.

Returns

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