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
Renders the documentation assembly to the output path specified in the project context.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.
RenderPlaceholdersAsync
Renders placeholder conceptual content files for the documentation assembly.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
model | CloudNimble.DotNetDocs.Core.DocAssembly | The documentation assembly to generate placeholders for. |
Returns
Type:System.Threading.Tasks.Task
A task representing the asynchronous placeholder rendering operation.