MkDocsAliases.

MkDocsServe(ICakeContext, MkDocsServeSettings) Method

Summary

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

Syntax

public static void MkDocsServe(this ICakeContext context, MkDocsServeSettings settings)

Examples

MkDocsServe(new MkDocsServeSettings()
{
    DevAddr = new MkDocsAddress("localhost", 8090),
    Theme = MkDocsTheme.ReadTheDocs
});
try
{
    MkDocsServe(new MkDocsServeSettings()
    {
        ToolTimeout = new TimeSpan(0, 0, 1, 0)
    });
}
catch (TimeoutException)
{
    // Kill tool process after 1 minute
}

Remarks

This method will block build process. Use Ctrl+C in console to quit.

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Parameters

Name Type Description
context ICakeContext The context.
settings MkDocsServeSettings The settings.

Return Value

Type Description
void