MkDocsTool<TSettings> Class

Summary

Base class for all MkDocs related tools.
Assembly
Cake.MkDocs.dll
Namespace
Cake.MkDocs
Base Types
Derived Types
graph BT Type-->Base0["Tool<TSettings>"] Type["MkDocsTool<TSettings>"] class Type type-node Derived0["MkDocsServeRunner"]-->Type click Derived0 "/api/Cake.MkDocs.Serve/MkDocsServeRunner" Derived1["MkDocsGhDeployRunner"]-->Type click Derived1 "/api/Cake.MkDocs.GhDeploy/MkDocsGhDeployRunner" Derived2["MkDocsVersionRunner"]-->Type click Derived2 "/api/Cake.MkDocs.Version/MkDocsVersionRunner" Derived3["MkDocsNewRunner"]-->Type click Derived3 "/api/Cake.MkDocs.New/MkDocsNewRunner" Derived4["MkDocsServeAsyncRunner"]-->Type click Derived4 "/api/Cake.MkDocs.Serve/MkDocsServeAsyncRunner" Derived5["MkDocsBuildRunner"]-->Type click Derived5 "/api/Cake.MkDocs.Build/MkDocsBuildRunner"

Syntax

public abstract class MkDocsTool<TSettings> : Tool<TSettings> where TSettings : MkDocsSettings

Type Parameters

Name Description
TSettings the settings type.

Constructors

Name Summary
MkDocsTool(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Initializes a new instance of the MkDocsTool<TSettings> class.

Methods

Name Value Summary
BuildArguments(TSettings, Action<ProcessArgumentBuilder>) ProcessArgumentBuilder
Builds process arguments based on settings.
GetToolExecutableNames() IEnumerable<string>
Gets the possible names of the tool executable.
GetToolName() string
Gets the name of the tool.
Run(TSettings, Action<ProcessArgumentBuilder>) void
Runs the tool using the specified settings. Creates process arguments based on settings attribute.
Run(TSettings, DirectoryPath, Action<ProcessArgumentBuilder>) void
Runs the tool using the specified settings and change process workig directory. Creates process arguments based on settings attribute.
Run(TSettings, ProcessSettings, Action<IProcess>, Action<ProcessArgumentBuilder>) void
Runs the tool using a custom tool path and the specified settings. Creates process arguments based on settings attribute.

Extension Methods

Name Value Summary
Dump<MkDocsTool<TSettings>>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<MkDocsTool<TSettings>>(MkDocsTool<TSettings>[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<MkDocsTool<TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<MkDocsTool<TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<MkDocsTool<TSettings>>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<MkDocsTool<TSettings>>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin