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 (project in working directory).
- Assembly
- Cake
.MkDocs .dll - Namespace
- Cake
.MkDocs - Containing Type
- MkDocsAliases
Syntax
public static void MkDocsGhDeploy(this ICakeContext context, MkDocsGhDeploySettings settings)Examples
MkDocsGhDeploy(new MkDocsGhDeploySettings()
{
RemoteBranch = "pages-branch",
RemoteName = "second-origin"
});Remarks
See GitHub Pages.
See MkDocs guide.
Attributes
| Type | Description |
|---|---|
| Cake |
|
| Cake |
|
| Cake |
Parameters
| Name | Type | Description |
|---|---|---|
| context | ICakeContext | The context. |
| settings | Mk |
The settings. |
Return Value
| Type | Description |
|---|---|
| void |