JekyllSettings Class

Summary

Jekyll tool settings.
Assembly
Cake.Jekyll.dll
Namespace
Cake.Jekyll
Base Types
  • ToolSettings
Derived Types
graph BT Type-->Base0["ToolSettings"] Type["JekyllSettings"] class Type type-node Derived0["JekyllDoctorSettings"]-->Type click Derived0 "/api/Cake.Jekyll.Commands.Doctor/JekyllDoctorSettings" Derived1["JekyllBuildSettings"]-->Type click Derived1 "/api/Cake.Jekyll.Commands.Build/JekyllBuildSettings" Derived2["JekyllNewSettings"]-->Type click Derived2 "/api/Cake.Jekyll.Commands.New/JekyllNewSettings" Derived3["JekyllCleanSettings"]-->Type click Derived3 "/api/Cake.Jekyll.Commands.Clean/JekyllCleanSettings" Derived4["JekyllNewThemeSettings"]-->Type click Derived4 "/api/Cake.Jekyll.Commands.NewTheme/JekyllNewThemeSettings" Derived5["JekyllServeSettings"]-->Type click Derived5 "/api/Cake.Jekyll.Commands.Serve/JekyllServeSettings" Derived6["JekyllVersionSettings"]-->Type click Derived6 "/api/Cake.Jekyll.Commands.Version/JekyllVersionSettings"

Syntax

public abstract class JekyllSettings : ToolSettings

Constructors

Name Summary
JekyllSettings(string) Initializes a new instance of the JekyllSettings class.

Properties

Name Value Summary
Command string
Gets the command which should be run.
DoNotUseBundler Nullable<bool>
Gets or sets if Bundler should *not* be used to execute Jekyll (defaults to ). `jekyll` instead of `bundle exec`...

Methods

Name Value Summary
ApplyOption(ProcessArgumentBuilder, Nullable<JekyllLogLevel>) void
Apply option for the Jekyll Log Level
ApplyOption(ProcessArgumentBuilder, string, Nullable<bool>) void
Apply option from a nullable boolean value
ApplyOption(ProcessArgumentBuilder, string, Nullable<int>) void
Apply option from a nullable int value
ApplyOption(ProcessArgumentBuilder, string, Nullable<TimeSpan>) void
Apply option from one or more string values
ApplyOption(ProcessArgumentBuilder, string, OneOrMoreDirectoryPaths) void
Apply option from directory path(s)
ApplyOption(ProcessArgumentBuilder, string, OneOrMoreFilePaths) void
Apply option from file path(s)
ApplyOption(ProcessArgumentBuilder, string, OneOrMoreStrings) void
Apply option from one or more string values
ApplyOption(ProcessArgumentBuilder, string, string) void
Apply option from a string value
ApplyValue(ProcessArgumentBuilder, string) void
Apply option from a string value
EvaluateCore(ProcessArgumentBuilder) void
Evaluates the settings and writes them to args.

Extension Methods

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