DocFxBuildAliases.

DocFxBuild(ICakeContext, FilePath) Method

Summary

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

Syntax

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

Examples

DocFxBuild("./docs/docfx.json");

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.

Return Value

Type Description
void