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

Contains settings used by MkDocsGhDeployRunner.

Assembly

Cake.MkDocs.dll

Namespace

Cake.MkDocs.GhDeploy

Base Types

ToolSettings
MkDocsSettings

graph BT Type-->Base0["MkDocsSettings"] click Base0 "/api/Cake.MkDocs/MkDocsSettings" Base0-->Base1["ToolSettings"] Type["MkDocsGhDeploySettings"] class Type type-node

Syntax

public sealed class MkDocsGhDeploySettings : MkDocsSettings

Remarks

See GitHub Pages.

See MkDocs guide.

Attributes

Type	Description
MkDocsCommandAttribute

Constructors

Name	Summary
MkDocsGhDeploySettings()

Properties

Name	Value	Summary
Clean	bool	Gets or sets a value indicating whether clean mode is enabled. Remove old files from the site_dir before building (the default).
ConfigFile	FilePath	Gets or sets a value indicating whether a specific config is provided. Provide a specific `MkDocs` config.
Dirty	bool	Gets or sets a value indicating whether dirty mode is enabled. DO NOT remove old files from the site_dir before building.
Force	bool	Gets or sets a value indicating whether force push is required. Force the push to the repository.
IgnoreVersion	bool	Gets or sets a value indicating whether ignore version push is required. Ignore check that build is not being deployed with an older version of MkDocs.
Message	string	Gets or sets a value indicating whether a specific commit message is provided. A commit message to use when commiting to the `GitHub Pages` remote branch.
Quiet	bool	Gets or sets a value indicating whether quiet mode is enabled. Silence warnings. Inherited from MkDocsSettings
RemoteBranch	string	Gets or sets a value indicating whether a custom remote branch is provided. The remote branch to commit to for `GitHub Pages`. This overrides the value specified in config.
RemoteName	string	Gets or sets a value indicating whether a custom remote name is provided. The remote name to commit to for `GitHub Pages`. This overrides the value specified in config.
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<MkDocsGhDeploySettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<MkDocsGhDeploySettings>(MkDocsGhDeploySettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<MkDocsGhDeploySettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<MkDocsGhDeploySettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<MkDocsGhDeploySettings>(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<MkDocsGhDeploySettings>(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