MkDocsNewSettings Class

Summary

Contains settings used by MkDocsNewRunner.
Assembly
Cake.MkDocs.dll
Namespace
Cake.MkDocs.New
Base Types
graph BT Type-->Base0["MkDocsSettings"] click Base0 "/api/Cake.MkDocs/MkDocsSettings" Base0-->Base1["ToolSettings"] Type["MkDocsNewSettings"] class Type type-node

Syntax

public sealed class MkDocsNewSettings : MkDocsSettings

Attributes

Type Description
MkDocsCommandAttribute

Constructors

Name Summary
MkDocsNewSettings()

Properties

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

Silence warnings.

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

Enable verbose output.

Inherited from MkDocsSettings

Extension Methods

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