MkDocsGhDeployRunner Class

Summary

The MkDocs gh-deploy tool deploying created site to GitHub Pages.
Namespace
Cake.MkDocs.GhDeploy
Base Types
graph BT Type-->Base0["MkDocsTool<MkDocsGhDeploySettings>"] Base0-->Base1["Tool<MkDocsGhDeploySettings>"] Type["MkDocsGhDeployRunner"] class Type type-node

Syntax

public sealed class MkDocsGhDeployRunner : MkDocsTool<MkDocsGhDeploySettings>

Remarks

See GitHub Pages.

See MkDocs guide.

Constructors

Name Summary
MkDocsGhDeployRunner(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator) Initializes a new instance of the MkDocsGhDeployRunner class.

Methods

Name Value Summary
GhDeploy(DirectoryPath, MkDocsGhDeploySettings) void
Deploy your documentation to GitHub Pages.
GhDeploy(MkDocsGhDeploySettings) void
Deploy your documentation to GitHub Pages (project in working directory).
GitHub