JekyllNewSettings Class

Summary

Contains settings used by Cake.Jekyll.Commands.New.JekyllNewCommand.
Assembly
Cake.Jekyll.dll
Namespace
Cake.Jekyll.Commands.New
Base Types
graph BT Type-->Base0["JekyllSettings"] click Base0 "/api/Cake.Jekyll/JekyllSettings" Base0-->Base1["ToolSettings"] Type["JekyllNewSettings"] class Type type-node

Syntax

public class JekyllNewSettings : JekyllSettings

Constructors

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

Properties

Name Value Summary
Blank Nullable<bool>
Creates scaffolding but with empty files (defaults to ). --blank
Command string
Gets the command which should be run.
Inherited from JekyllSettings
Destination DirectoryPath
Site Destination directory, the directory where Jekyll will write files (defaults to `./_site`). -d, --destination DIR Important: The contents of Destination are automatically cleaned, by default, when the site is built. Files or folders that are not created by your site will be removed. Some files could be retained by specifying them within the `keep_files` configuration directive. Do not use an important location for Destination; instead, use it as a staging area and copy files from there to your web server.
DoNotUseBundler Nullable<bool>
Gets or sets if Bundler should *not* be used to execute Jekyll (defaults to ). `jekyll` instead of `bundle exec`...
Inherited from JekyllSettings
Force Nullable<bool>
Force creation even if PATH already exists (defaults to ). --force
Layouts DirectoryPath
Specifies layout directory instead of using `_layouts/` automatically. --layouts DIR
LiquidProfile Nullable<bool>
Generate a Liquid rendering profile to help you identify performance bottlenecks. --profile
Path DirectoryPath
Path to scaffold the site.
Plugins OneOrMoreDirectoryPaths
Specifies plugin directories instead of using `_plugins/` automatically. -p, --plugins DIR1[,DIR2,...]
SafeMode Nullable<bool>
Safe mode (defaults to ). --safe Disable non-whitelisted plugins, caching to disk, and ignore symbolic links.
SkipBundle Nullable<bool>
Skip `bundle install` (defaults to ). --skip-bundle
Source DirectoryPath
Site Source directory, the directory where Jekyll will read files (defaults to `./`). -s, --source DIR
Trace Nullable<bool>
Show the full backtrace when an error occurs. -t, --trace

Methods

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

Extension Methods

Name Value Summary
DoNotUseBundler(Nullable<bool>) JekyllNewSettings
Specifies if Bundler should not be used to execute Jekyll. `jekyll` instead of `bundle exec`...
Requires the Cake.Jekyll addin
Dump<JekyllNewSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
EnableBlank(bool) JekyllNewSettings
Sets if scaffolding should created with empty files. --blank
Requires the Cake.Jekyll addin
EnableForce(bool) JekyllNewSettings
Sets if should force creation even if Path already exists. --force
Requires the Cake.Jekyll addin
EnableLiquidProfile(bool) JekyllNewSettings
Sets if a Liquid rendering profile should be generated. --profile Liquid rendering profile helps you identify performance bottlenecks.
Requires the Cake.Jekyll addin
EnableSafeMode(bool) JekyllNewSettings
Sets if both non-whitelisted plugins and caching to disk should be disabled, and if symbolic links should be ignored. --safe
Requires the Cake.Jekyll addin
EnableTrace(bool) JekyllNewSettings
Sets if the full backtrace should be shown when an error occurs. -t, --trace
Requires the Cake.Jekyll addin
IsIn<JekyllNewSettings>(JekyllNewSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<JekyllNewSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<JekyllNewSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
SetDestination(DirectoryPath) JekyllNewSettings
Sets the Site Destination directory (defaults to `./_site`). -d, --destination DIR
Requires the Cake.Jekyll addin
SetLayouts(DirectoryPath) JekyllNewSettings
Sets the layout directory instead of using `_layouts/` automatically --layouts DIR
Requires the Cake.Jekyll addin
SetSource(DirectoryPath) JekyllNewSettings
Sets the Site Source directory, the directory where Jekyll will read files (defaults to `./`). -s, --source DIR
Requires the Cake.Jekyll addin
SetWorkingDirectory(DirectoryPath) JekyllNewSettings
Sets the working directory which should be used to run the Jekyll command.
Requires the Cake.Jekyll addin
SkipBundle(bool) JekyllNewSettings
Sets if `bundle install` should be skipped. --safe
Requires the Cake.Jekyll addin
ThrowIfNull<JekyllNewSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<JekyllNewSettings>(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
WithPlugins(DirectoryPath[]) JekyllNewSettings
Sets the Plugins directory instead of using `_plugins/` automatically. -p, --plugins DIR1[,DIR2,...]
Requires the Cake.Jekyll addin