MkDocsBuildSettings Class

Summary

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

Syntax

[MkDocsCommand("build")]
public sealed class MkDocsBuildSettings : MkDocsSettings

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.

true - force dirty mode build false - default cleaning mode;
Quiet bool
Gets or sets a value indicating whether quiet mode is enabled.

Silence warnings.

Inherited from MkDocsSettings
SiteDir DirectoryPath
Gets or sets a value indicating whether custom site dir is provided.

The directory to output the result of the documentation build.
Strict bool
Gets or sets a value indicating whether strict mode is enabled.

Enable strict mode. This will cause MkDocs to abort the build on any warnings.
Theme MkDocsTheme?
Gets or sets a value indicating whether different theme should be used.

The theme to use when building your documentation.
ThemeDir DirectoryPath
Gets or sets a value indicating whether custom theme dir is provided.

The theme directory to use when building your documentation.
Verbose bool
Gets or sets a value indicating whether verbose mode is enabled.

Enable verbose output.

Inherited from MkDocsSettings
GitHub