DocFxServeAliases.

DocFxServeStart(ICakeContext) Method

Summary

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

Syntax

public static IProcess DocFxServeStart(this ICakeContext context)

Examples

using (var process = DocFxServeStart("./docs")) 
{
    // 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.

Return Value

Type Description
IProcess The process serving the website.