MkDocsAliases.

MkDocsServeAsync(ICakeContext) Method

Summary

Run the builtin development server async in working directory.
Assembly
Cake.MkDocs.dll
Namespace
Cake.MkDocs
Containing Type
MkDocsAliases

Syntax

public static Task MkDocsServeAsync(this ICakeContext context)

Examples

var task = MkDocsServeAsync();
// Do work...
task.Wait();

Remarks

This method will block build process. Use Ctrl+C in console to quit or use System.Threading.CancellationToken to cancel task programmatically.

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Parameters

Name Type Description
context ICakeContext The context.

Return Value

Type Description
Task Long running task.