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 - Containing Type
- MkDocsAliases
Syntax
public static void MkDocsGhDeploy(this ICakeContext context, DirectoryPath projectDirectory)Examples
MkDocsGhDeploy("./docs-project";MkDocsGhDeploy(new DictionaryPath("./docs-project"));Remarks
See GitHub Pages.
See MkDocs guide.
Attributes
| Type | Description |
|---|---|
| Cake |
|
| Cake |
|
| Cake |
Parameters
| Name | Type | Description |
|---|---|---|
| context | ICakeContext | The context. |
| projectDirectory | DirectoryPath | Project directory path to deploy. |
Return Value
| Type | Description |
|---|---|
| void |