MkDocsTool<TSettings>.

BuildArguments(TSettings, Action<ProcessArgumentBuilder>) Method

Summary

Builds process arguments based on settings.
Assembly
Cake.MkDocs.dll
Namespace
Cake.MkDocs
Containing Type
MkDocsTool<TSettings>

Syntax

protected ProcessArgumentBuilder BuildArguments(TSettings settings, Action<ProcessArgumentBuilder> setCommandValues = null)

Examples

 // MkDocsNewSettings are related to "new" process command
 var settings = new MkDocsNewSettings()
 {
     Quiet = true
 };
 var argumentBuilder = BuildArguments(settings, arguments => arguments.Append("./project-directory"));

 // Generate arguments: "new ./project-directory --quiet"

Parameters

Name Type Description
settings TSettings The settings.
setCommandValues Action<ProcessArgumentBuilder> If specified called during process argument building.

Return Value

Type Description
ProcessArgumentBuilder ProcessArgumentBuilder with all commands and arguments for process.