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
Deploy your documentation to
GitHub Pages.
- Assembly
- Cake
.MkDocs .dll - Namespace
- Cake
.MkDocs .GhDeploy - Containing Type
- MkDocsGhDeployRunner
Syntax
public void GhDeploy(DirectoryPath projectDirectory, MkDocsGhDeploySettings settings)Examples
runner.GhDeploy(new DirectoryPath("./project-with-docs-is-here"), new MkDocsGhDeploySettings());Parameters
| Name | Type | Description |
|---|---|---|
| projectDirectory | DirectoryPath | Project dir to deploy. |
| settings | Mk |
The settings. |
Return Value
| Type | Description |
|---|---|
| void |