MkDocsAliases.

MkDocsGhDeploy(ICakeContext, DirectoryPath, MkDocsGhDeploySettings) Method

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, MkDocsGhDeploySettings settings)

Examples

MkDocsGhDeploy("./docs-project", new MkDocsGhDeploySettings()
{
    RemoteBranch = "pages-branch",
    RemoteName = "second-origin"
});
MkDocsGhDeploy(new DictionaryPath("./docs-project"), 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.
projectDirectory DirectoryPath Project directory path to deploy.
settings MkDocsGhDeploySettings The settings.

Return Value

Type Description
void