MkDocsNewRunner Class

Summary

The MkDocs new tool creates a new MkDocs project.
graph BT Type-->Base0["MkDocsTool<MkDocsNewSettings>"] Base0-->Base1["Tool<MkDocsNewSettings>"] Type["MkDocsNewRunner"] class Type type-node

Syntax

public sealed class MkDocsNewRunner : MkDocsTool<MkDocsNewSettings>

Constructors

Methods

Name Value Summary
New(DirectoryPath, MkDocsNewSettings) void
Create a new MkDocs project.
New(MkDocsNewSettings) void
Create a new MkDocs project in current directory.

Extension Methods

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