DocFxInitAliases.

DocFxInit(ICakeContext, DocFxInitSettings) Method

Summary

Generate an initial docfx.json file, with the specified settings.
Assembly
Cake.DocFx.dll
Namespace
Cake.DocFx
Containing Type
DocFxInitAliases

Syntax

public static void DocFxInit(this ICakeContext context, DocFxInitSettings settings)

Examples

DocFxInit(new DocFxInitSettings()
{
    OutputPath = "./docs"
});
DocFxInit(new DocFxInitSettings()
{
    OutputPath = "./docs",
    OnlyConfigFile = true
});

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

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

Return Value

Type Description
void