DocFxBuildAliases.

DocFxBuild(ICakeContext, FilePath, DocFxBuildSettings) Method

Summary

Generate client-only website combining API in YAML files and conceptual files for a specific docfx.json file using the specified settings.
Assembly
Cake.DocFx.dll
Namespace
Cake.DocFx
Containing Type
DocFxBuildAliases

Syntax

public static void DocFxBuild(this ICakeContext context, FilePath configFile, DocFxBuildSettings settings)

Examples

DocFxBuild("./docs/docfx.json", new DocFxBuildSettings()
{
    OutputPath = "./artifacts/docs",
    TemplateFolder = "default"
});

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

Name Type Description
context ICakeContext The Cake context.
configFile FilePath The optional path to a DocFx config file. If no value is passed the docfx.json file in the current working directory will be used.
settings DocFxBuildSettings The optional DocFx settings. If no settings are passed default settings are used.

Return Value

Type Description
void