This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.MkDocs.

Summary

Base MkDocs settings class.

Assembly

Cake.MkDocs.dll

Namespace

Cake.MkDocs

Base Types

ToolSettings

Derived Types

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

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. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<MkDocsSettings>(MkDocsSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<MkDocsSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<MkDocsSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<MkDocsSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<MkDocsSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin

MkDocsSettings Class

Summary

Syntax

Constructors

Properties

Extension Methods