DocFxPdfAliases.

DocFxPdf(ICakeContext, DocFxPdfSettings) Method

Summary

Generates a PDF document for the docfx.json file in the current working directory using the specified settings.
Assembly
Cake.DocFx.dll
Namespace
Cake.DocFx
Containing Type
DocFxPdfAliases

Syntax

public static void DocFxPdf(this ICakeContext context, DocFxPdfSettings settings)

Examples

DocFxPdf(new DocFxPdfSettings()
{
    OutputPath = "./artifacts/docs",
    TemplateFolder = "default"
});

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

Name Type Description
context ICakeContext The Cake context.
settings DocFxPdfSettings The optional DocFx settings. If no settings are passed default settings are used.

Return Value

Type Description
void