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

Derived Types

Syntax

public abstract class MkDocsSettings : ToolSettings

Name	Summary
MkDocsSettings()

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.

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