JekyllTool<TSettings> Class

Summary

Base class for all Jekyll tools.
Assembly
Cake.Jekyll.dll
Namespace
Cake.Jekyll
Base Types
graph BT Type-->Base0["Tool<TSettings>"] Type["JekyllTool<TSettings>"] class Type type-node

Syntax

public abstract class JekyllTool<TSettings> : Tool<TSettings> where TSettings : JekyllSettings

Type Parameters

Name Description
TSettings The settings type.

Constructors

Properties

Name Value Summary
CakeLog ICakeLog
Cake log instance.

Methods

Name Value Summary
GetArguments(TSettings) ProcessArgumentBuilder
Builds the arguments for Jekyll.
GetToolExecutableNames() IEnumerable<string>
Gets the possible names of the tool executable.
GetToolName() string
Gets the name of the tool.
RunCore(TSettings) void
Runs Jekyll.
RunCore(TSettings, ProcessSettings, Action<IProcess>) void
Runs Jekyll.

Extension Methods

Name Value Summary
Dump<JekyllTool<TSettings>>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<JekyllTool<TSettings>>(JekyllTool<TSettings>[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<JekyllTool<TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<JekyllTool<TSettings>>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<JekyllTool<TSettings>>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<JekyllTool<TSettings>>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin