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.Jekyll.

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

Name	Description
TSettings	The settings type.

Name	Summary
JekyllTool(IFileSystem, ICakeEnvironment, IProcessRunner, IToolLocator, ICakeLog)	Initializes a new instance of the `JekyllTool<TSettings>` class.

Name	Value	Summary
CakeLog	ICakeLog	Cake log instance.

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, ProcessSettings, Action<IProcess>)	void	Runs Jekyll.
RunCore(TSettings)	void	Runs Jekyll.

Name	Value	Summary
Dump<JekyllTool<TSettings>>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<JekyllTool<TSettings>>(JekyllTool<TSettings>[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<JekyllTool<TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<JekyllTool<TSettings>>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<JekyllTool<TSettings>>(string, string)	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<JekyllTool<TSettings>>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin