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
The
MkDocs gh-deploy tool deploying created site to GitHub Pages.
- Assembly
- Cake
.MkDocs .dll - 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 |
Initializes a new instance of the MkDocsGhDeployRunner class.
|
Methods
| Name | Value | Summary |
|---|---|---|
| GhDeploy |
void |
Deploy your documentation to
GitHub Pages.
|
| GhDeploy |
void |
Deploy your documentation to
GitHub Pages (project in working directory).
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
| To |
string |
From StringExtensions
Requires the Cake.Issues addin
|