Skip to main content

​
Definition

Assembly: CloudNimble.DotNetDocs.Mintlify.dll Namespace: CloudNimble.DotNetDocs.Core.Configuration Inheritance: System.Object

​
Syntax

CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsMintlify_DotNetDocsBuilderExtensions

​
Summary

Extension methods for adding Mintlify support to the DotNetDocs pipeline builder.

​
Methods

​
UseMintlifyRenderer

Adds the Mintlify renderer to the documentation pipeline.

​
Syntax

public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder)

​
Parameters

NameTypeDescription
builderCloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilderThe DotNetDocs pipeline builder.

​
Returns

Type: CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder The builder for chaining.

​
Examples

services.AddDotNetDocsPipeline(pipeline =>
{
    pipeline
        .UseMintlifyRenderer()
        .ConfigureContext(ctx => ctx.OutputPath = "docs/api");
});

​
Remarks

This method registers:

​
UseMintlifyRenderer

Adds the Mintlify renderer to the documentation pipeline with configuration options.

​
Syntax

public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder, System.Action<CloudNimble.DotNetDocs.Mintlify.MintlifyRendererOptions> configureMintlify)

​
Parameters

NameTypeDescription
builderCloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilderThe DotNetDocs pipeline builder.
configureMintlifySystem.Action<CloudNimble.DotNetDocs.Mintlify.MintlifyRendererOptions>Action to configure Mintlify options.

​
Returns

Type: CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder The builder for chaining.

​
Examples

services.AddDotNetDocsPipeline(pipeline =&gt;
{
    pipeline
        .UseMintlifyRenderer(options =&gt;
        {
            options.GenerateDocsJson = true;
            options.IncludeIcons = true;
        })
        .ConfigureContext(ctx =&gt; ctx.OutputPath = "docs/api");
});

​
Remarks

This method registers:

​
UseMintlifyRenderer

Adds a custom Mintlify renderer implementation to the documentation pipeline.

​
Syntax

public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer<TRenderer>(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder) where TRenderer : CloudNimble.DotNetDocs.Mintlify.MintlifyRenderer

​
Parameters

NameTypeDescription
builderCloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilderThe DotNetDocs pipeline builder.

​
Returns

Type: CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder The builder for chaining.

​
Type Parameters

  • TRenderer - The type of Mintlify renderer to add.

​
Examples

services.AddDotNetDocsPipeline(pipeline =&gt;
{
    pipeline
        .UseMintlifyRenderer&lt;CustomMintlifyRenderer&gt;()
        .ConfigureContext(ctx =&gt; ctx.OutputPath = "docs");
});

​
Remarks

The renderer must inherit from MintlifyRenderer. This method also registers:

​
UseMintlifyRenderer

Adds a custom Mintlify renderer implementation to the documentation pipeline with configuration options.

​
Syntax

public static CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder UseMintlifyRenderer<TRenderer>(CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder builder, System.Action<CloudNimble.DotNetDocs.Mintlify.MintlifyRendererOptions> configureMintlify) where TRenderer : CloudNimble.DotNetDocs.Mintlify.MintlifyRenderer

​
Parameters

NameTypeDescription
builderCloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilderThe DotNetDocs pipeline builder.
configureMintlifySystem.Action<CloudNimble.DotNetDocs.Mintlify.MintlifyRendererOptions>Action to configure Mintlify options.

​
Returns

Type: CloudNimble.DotNetDocs.Core.Configuration.DotNetDocsBuilder The builder for chaining.

​
Type Parameters

  • TRenderer - The type of Mintlify renderer to add.

​
Examples

services.AddDotNetDocsPipeline(pipeline =&gt;
{
    pipeline
        .UseMintlifyRenderer&lt;CustomMintlifyRenderer&gt;(options =&gt;
        {
            options.GenerateDocsJson = true;
        })
        .ConfigureContext(ctx =&gt; ctx.OutputPath = "docs");
});

​
Remarks

The renderer must inherit from MintlifyRenderer. This method also registers: