JekyllDoctorSettingsExtensions Class

Summary

Extensions for JekyllDoctorSettings.
Assembly
Cake.Jekyll.dll
Namespace
Cake.Jekyll.Commands.Doctor
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["JekyllDoctorSettingsExtensions"] class Type type-node

Syntax

public static class JekyllDoctorSettingsExtensions

Methods

Name Value Summary
DoNotUseBundler(JekyllDoctorSettings, Nullable<bool>) JekyllDoctorSettings
Specifies if Bundler should not be used to execute Jekyll. `jekyll` instead of `bundle exec`...
static
EnableLiquidProfile(JekyllDoctorSettings, bool) JekyllDoctorSettings
Sets if a Liquid rendering profile should be generated. --profile Liquid rendering profile helps you identify performance bottlenecks.
static
EnableSafeMode(JekyllDoctorSettings, bool) JekyllDoctorSettings
Sets if both non-whitelisted plugins and caching to disk should be disabled, and if symbolic links should be ignore. --safe
static
EnableTrace(JekyllDoctorSettings, bool) JekyllDoctorSettings
Sets if the full backtrace should be shown when an error occurs. -t, --trace
static
SetDestination(JekyllDoctorSettings, DirectoryPath) JekyllDoctorSettings
Sets the Site Destination directory (defaults to `./_site`). -d, --destination DIR
static
SetLayouts(JekyllDoctorSettings, DirectoryPath) JekyllDoctorSettings
Sets the layout directory instead of using `_layouts/` automatically --layouts DIR
static
SetSource(JekyllDoctorSettings, DirectoryPath) JekyllDoctorSettings
Sets the Site Source directory, the directory where Jekyll will read files (defaults to `./`). -s, --source DIR
static
SetWorkingDirectory(JekyllDoctorSettings, DirectoryPath) JekyllDoctorSettings
Sets the working directory which should be used to run the Jekyll command.
static
WithConfiguration(JekyllDoctorSettings, FilePath[]) JekyllDoctorSettings
Specifies one or more configuration file(s) instead of using `_config.yml` automatically. Settings in later files override settings in earlier files.
static
WithPlugins(JekyllDoctorSettings, DirectoryPath[]) JekyllDoctorSettings
Sets the Plugins directory instead of using `_plugins/` automatically. -p, --plugins DIR1[,DIR2,...]
static

Extension Methods

Name Value Summary
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