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
Runs the tool using a custom tool path and the specified settings.
Creates process arguments based on settings attribute.
- Assembly
- Cake
.MkDocs .dll - Namespace
- Cake
.MkDocs - Containing Type
- MkDocsTool
<TSettings>
Syntax
protected void Run(TSettings settings, ProcessSettings processSettings, Action<IProcess> postAction, Action<ProcessArgumentBuilder> setCommandValues = null)Examples
// MkDocsBuildSettings are related to "build" process command
var settings = new MkDocsBuildSettings();
IEnumerable<string> output = null;
Run(settings, new DirectoryPath("./project-with-docs-is-here"), process => output = process.GetStandardOutput());Parameters
| Name | Type | Description |
|---|---|---|
| settings | TSettings | The settings. |
| processSettings | ProcessSettings | The process settings. |
| postAction | Action |
If specified called after process exit. |
| setCommandValues | Action |
If specified called during process argument building. |
Return Value
| Type | Description |
|---|---|
| void |