MkDocsSettings Class

Summary

Base MkDocs settings class.
graph BT Type-->Base0["ToolSettings"] Type["MkDocsSettings"] class Type type-node Derived0["MkDocsServeSettings"]-->Type click Derived0 "/api/Cake.MkDocs.Serve/MkDocsServeSettings" Derived1["MkDocsNewSettings"]-->Type click Derived1 "/api/Cake.MkDocs.New/MkDocsNewSettings" Derived2["MkDocsGhDeploySettings"]-->Type click Derived2 "/api/Cake.MkDocs.GhDeploy/MkDocsGhDeploySettings" Derived3["MkDocsVersionSettings"]-->Type click Derived3 "/api/Cake.MkDocs.Version/MkDocsVersionSettings" Derived4["MkDocsBuildSettings"]-->Type click Derived4 "/api/Cake.MkDocs.Build/MkDocsBuildSettings"

Syntax

public abstract class MkDocsSettings : ToolSettings

Constructors

Name Summary
MkDocsSettings()

Properties

Name Value Summary
Quiet bool
Gets or sets a value indicating whether quiet mode is enabled.

Silence warnings.

Verbose bool
Gets or sets a value indicating whether verbose mode is enabled.

Enable verbose output.

Extension Methods

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