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

Base class for all MkDocs related tools.

Assembly

Cake.MkDocs.dll

Namespace

Cake.MkDocs

Base Types

Tool<TSettings>

Derived Types

graph BT Type-->Base0["Tool<TSettings>"] Type["MkDocsTool<TSettings>"] class Type type-node Derived0["MkDocsNewRunner"]-->Type click Derived0 "/api/Cake.MkDocs.New/MkDocsNewRunner" Derived1["MkDocsVersionRunner"]-->Type click Derived1 "/api/Cake.MkDocs.Version/MkDocsVersionRunner" Derived2["MkDocsServeRunner"]-->Type click Derived2 "/api/Cake.MkDocs.Serve/MkDocsServeRunner" Derived3["MkDocsBuildRunner"]-->Type click Derived3 "/api/Cake.MkDocs.Build/MkDocsBuildRunner" Derived4["MkDocsGhDeployRunner"]-->Type click Derived4 "/api/Cake.MkDocs.GhDeploy/MkDocsGhDeployRunner" Derived5["MkDocsServeAsyncRunner"]-->Type click Derived5 "/api/Cake.MkDocs.Serve/MkDocsServeAsyncRunner"

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