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 an initial docfx.json file, with the specified settings.
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
