​
Definition

Assembly: CloudNimble.DotNetDocs.Core.dll Namespace: CloudNimble.DotNetDocs.Core.Renderers Inheritance: CloudNimble.DotNetDocs.Core.Renderers.RendererBase

​
Syntax

CloudNimble.DotNetDocs.Core.Renderers.YamlRenderer

​
Summary

Renders documentation as YAML files.

​
Remarks

Generates structured YAML documentation suitable for configuration files and integration with various documentation platforms.

​
Constructors

​
.ctor

Initializes a new instance of the YamlRenderer class.

​
Syntax

public YamlRenderer(CloudNimble.DotNetDocs.Core.ProjectContext context = null)

​
Parameters

NameTypeDescription
contextCloudNimble.DotNetDocs.Core.ProjectContext?The project context. If null, a default context is created.

​
Methods

​
RenderAsync

Renders the documentation assembly to YAML files.

​
Syntax

public 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.
  • CloudNimble.DotNetDocs.Core.IDocRenderer