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
Serve a website from the specified directory with the specified settings.
Syntax
public static void DocFxServe(this ICakeContext context, DirectoryPath path, DocFxServeSettings settings)
Examples
DocFxServe("./docs", new DocFxServeSettings
{
Hostname = "192.168.1.4",
Port = "9753"
});
Attributes
Type |
Description |
CakeMethodAliasAttribute |
|
CakeAliasCategoryAttribute |
|
Parameters
Name |
Type |
Description |
context |
ICakeContext |
The Cake context. |
path |
DirectoryPath |
The optional directory to serve.
If no value is passed the the current working directory will be used. |
settings |
DocFxServeSettings |
The optional DocFx settings.
If no settings are passed default settings are used. |
Return Value