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

The MkDocs build tool for MkDocs project.

Assembly

Cake.MkDocs.dll

Namespace

Cake.MkDocs.Build

Base Types

graph BT Type-->Base0["MkDocsTool<MkDocsBuildSettings>"] Base0-->Base1["Tool<MkDocsBuildSettings>"] Type["MkDocsBuildRunner"] class Type type-node

Syntax

public sealed class MkDocsBuildRunner : MkDocsTool<MkDocsBuildSettings>

Name	Summary
MkDocsBuildRunner(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator)	Initializes a new instance of the `MkDocsBuildRunner` class.

Name	Value	Summary
Build(DirectoryPath, MkDocsBuildSettings)	void	Build the `MkDocs` documentation.
Build(MkDocsBuildSettings)	void	Build the `MkDocs` documentation in working directory.

Name	Value	Summary
Dump<MkDocsBuildRunner>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<MkDocsBuildRunner>(MkDocsBuildRunner[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<MkDocsBuildRunner>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<MkDocsBuildRunner>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<MkDocsBuildRunner>(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<MkDocsBuildRunner>(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