This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see
Cake.DocFx.
Summary
Generate client-only website combining API in YAML files and conceptual files
for the docfx.json file in the current working directory using the specified settings.
Syntax
public static void DocFxBuild(this ICakeContext context, DocFxBuildSettings settings)
Examples
DocFxBuild(new DocFxBuildSettings()
{
OutputPath = "./artifacts/docs",
TemplateFolder = "default"
});
Attributes
| Type |
Description |
| CakeMethodAliasAttribute |
|
| CakeAliasCategoryAttribute |
|
Parameters
| Name |
Type |
Description |
| context |
ICakeContext |
The Cake context. |
| settings |
DocFxBuildSettings |
The optional DocFx settings.
If no settings are passed default settings are used. |
Return Value
