MkDocsServeRunner Class

Summary

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

Syntax

public sealed class MkDocsServeRunner : MkDocsTool<MkDocsServeSettings>

Constructors

Methods

Name Value Summary
Serve(DirectoryPath, MkDocsServeSettings) void
Run the builtin development server.
Serve(MkDocsServeSettings) void
Run the builtin development server in working directory.

Extension Methods

Name Value Summary
Dump<MkDocsServeRunner>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<MkDocsServeRunner>(MkDocsServeRunner[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<MkDocsServeRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<MkDocsServeRunner>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<MkDocsServeRunner>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<MkDocsServeRunner>(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
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin