DocFxServeAliases.

DocFxServeStart(ICakeContext, DirectoryPath, DocFxServeSettings) Method

Summary

Start serving a website from the specified directory with the specified settings.
Assembly
Cake.DocFx.dll
Namespace
Cake.DocFx
Containing Type
DocFxServeAliases

Syntax

public static IProcess DocFxServeStart(this ICakeContext context, DirectoryPath path, DocFxServeSettings settings)

Examples

using (var process = DocFxServeStart("./docs", new DocFxServeSettings
{
    Hostname = "192.168.1.4",
    Port = "9753"
})) 
{
    // Launch browser or other action based on the site
    process.WaitForExit();
}

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

Type Description
IProcess The process serving the website.