MkDocsGhDeployRunner Class

Summary

The MkDocs gh-deploy tool deploying created site to GitHub Pages.
graph BT Type-->Base0["MkDocsTool<MkDocsGhDeploySettings>"] Base0-->Base1["Tool<MkDocsGhDeploySettings>"] Type["MkDocsGhDeployRunner"] class Type type-node

Syntax

public sealed class MkDocsGhDeployRunner : MkDocsTool<MkDocsGhDeploySettings>

Remarks

See GitHub Pages.

See MkDocs guide.

Constructors

Methods

Name Value Summary
GhDeploy(DirectoryPath, MkDocsGhDeploySettings) void
Deploy your documentation to GitHub Pages.
GhDeploy(MkDocsGhDeploySettings) void
Deploy your documentation to GitHub Pages (project in working directory).

Extension Methods

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