Ghdeploy Command

MkDocs GitHub Pages deploy command

For more information see GitHub Pages site and MkDocs guide.

MkDocs project in working directory

GhDeploy MkDocs project:

MkDocsGhDeploy();

With settings:

MkDocsGhDeploy(new MkDocsGhDeploySettings()
{
    RemoteBranch = "pages-branch",
    RemoteName = "second-origin"
});

MkDocs project in different directory

GhDeploy MkDocs in provided directory:

MkDocsGhDeploy("./docs-project");
MkDocsGhDeploy(new DirectoryPath("./docs-project"));

With settings:

MkDocsGhDeploy"./docs-project", new MkDocsGhDeploySettings()
{
    RemoteBranch = "pages-branch",
    RemoteName = "second-origin"
});
MkDocsGhDeploy(new DirectoryPath("./docs-project") ,new MkDocsGhDeploySettings()
{
	RemoteBranch = "pages-branch",
    RemoteName = "second-origin"
});
GitHub