MkDocsAliases.

MkDocsGhDeploy(ICakeContext, MkDocsGhDeploySettings) Method

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
CakeMethodAliasAttribute
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Parameters

Name Type Description
context ICakeContext The context.
settings MkDocsGhDeploySettings The settings.

Return Value

Type Description
void