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
Build the
MkDocs documentation.
- Assembly
- Cake
.MkDocs .dll - Namespace
- Cake
.MkDocs .Build - Containing Type
- MkDocsBuildRunner
Syntax
public void Build(DirectoryPath projectDirectory, MkDocsBuildSettings settings)Examples
runner.Build(new DirectoryPath("./project-with-docs-is-here"), new MkDocsBuildSettings());Parameters
| Name | Type | Description |
|---|---|---|
| projectDirectory | DirectoryPath | Project dir to build. |
| settings | MkDocsBuildSettings | The settings. |
Return Value
| Type | Description |
|---|---|
| void |