Summary

The MkDocs serve tool buid and generate preview of MkDocs documentation.

Namespace

Cake.MkDocs.Serve

Base Types

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

Syntax

public sealed class MkDocsServeRunner : MkDocsTool<MkDocsServeSettings>

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

Name	Value	Summary
Serve(DirectoryPath, MkDocsServeSettings)	void	Run the builtin development server.
Serve(MkDocsServeSettings)	void	Run the builtin development server in working directory.