MkDocsGhDeploySettings Class

Summary

Contains settings used by MkDocsGhDeployRunner.
Namespace
Cake.MkDocs.GhDeploy
Base Types
graph BT Type-->Base0["MkDocsSettings"] click Base0 "/Cake.MkDocs/api/Cake.MkDocs/MkDocsSettings" Base0-->Base1["ToolSettings"] Type["MkDocsGhDeploySettings"] class Type type-node

Syntax

[MkDocsCommand("gh-deploy")]
public sealed class MkDocsGhDeploySettings : MkDocsSettings

Remarks

See GitHub Pages.

See MkDocs guide.

Attributes

Type Description
MkDocsCommandAttribute

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
GitHub