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 the specified settings and change process workig directory.
Creates process arguments based on settings attribute.
- Assembly
- Cake
.MkDocs .dll - Namespace
- Cake
.MkDocs - Containing Type
- MkDocsTool
<TSettings>
Syntax
protected void Run(TSettings settings, DirectoryPath projectDirectory, Action<ProcessArgumentBuilder> setCommandValues = null)Examples
// MkDocsBuildSettings are related to "build" process command
var settings = new MkDocsBuildSettings();
Run(settings, new DirectoryPath("./project-with-docs-is-here"));Parameters
| Name | Type | Description |
|---|---|---|
| settings | TSettings | The settings. |
| projectDirectory | DirectoryPath | Process working directory. |
| setCommandValues | Action |
If specified called during process argument building. |
Return Value
| Type | Description |
|---|---|
| void |