MkDocsServeAsyncRunner Class

Summary

The MkDocs serve async tool buid and generate preview of MkDocs documentation.
graph BT Type-->Base0["MkDocsTool<MkDocsServeAsyncSettings>"] Base0-->Base1["Tool<MkDocsServeAsyncSettings>"] Type["MkDocsServeAsyncRunner"] class Type type-node

Syntax

public sealed class MkDocsServeAsyncRunner : MkDocsTool<MkDocsServeAsyncSettings>

Constructors

Methods

Name Value Summary
ServeAsync(DirectoryPath, MkDocsServeAsyncSettings) Task
Run the builtin development server async.
ServeAsync(MkDocsServeAsyncSettings) Task
Run the builtin development server in working directory async.

Extension Methods

Name Value Summary
Dump<MkDocsServeAsyncRunner>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<MkDocsServeAsyncRunner>(MkDocsServeAsyncRunner[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<MkDocsServeAsyncRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<MkDocsServeAsyncRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<MkDocsServeAsyncRunner>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<MkDocsServeAsyncRunner>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin