Summary

The MkDocs build tool for MkDocs project.

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.