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
Contains settings used by
Cake.Jekyll.Commands.New.JekyllNewCommand
.
- Assembly
- Cake
.Jekyll .dll - Namespace
- Cake
.Jekyll .Commands .New - Base Types
-
- ToolSettings
- JekyllSettings
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 |
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 |
Gets or sets if Bundler should *not* be used to execute Jekyll (defaults to
).
`jekyll` instead of `bundle exec`...
Inherited from JekyllSettings
|
Force | Nullable |
Force creation even if PATH already exists (defaults to
).
--force
|
Layouts | DirectoryPath |
Specifies layout directory instead of using `_layouts/` automatically.
--layouts DIR
|
LiquidProfile | Nullable |
Generate a Liquid rendering profile to help you identify performance bottlenecks.
--profile
|
Path | DirectoryPath |
Path to scaffold the site.
|
Plugins | One |
Specifies plugin directories instead of using `_plugins/` automatically.
-p, --plugins DIR1[,DIR2,...]
|
SafeMode | Nullable |
Safe mode (defaults to
).
--safe
Disable non-whitelisted plugins, caching to disk, and ignore symbolic links.
|
SkipBundle | Nullable |
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 |
Show the full backtrace when an error occurs.
-t, --trace
|
Methods
Extension Methods
Name | Value | Summary |
---|---|---|
DoNotUseBundler |
JekyllNewSettings |
Specifies if Bundler should not be used to execute Jekyll.
`jekyll` instead of `bundle exec`...
Requires the Cake.Jekyll addin
|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
EnableBlank |
JekyllNewSettings |
Sets if scaffolding should created with empty files.
--blank
Requires the Cake.Jekyll addin
|
EnableForce |
JekyllNewSettings |
Sets if should force creation even if
Path already exists.
--force
Requires the Cake.Jekyll addin
|
EnableLiquidProfile |
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 |
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 |
JekyllNewSettings |
Sets if the full backtrace should be shown when an error occurs.
-t, --trace
Requires the Cake.Jekyll addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
SetDestination |
JekyllNewSettings |
Sets the Site Destination directory (defaults to `./_site`).
-d, --destination DIR
Requires the Cake.Jekyll addin
|
SetLayouts |
JekyllNewSettings |
Sets the layout directory instead of using `_layouts/` automatically
--layouts DIR
Requires the Cake.Jekyll addin
|
SetSource |
JekyllNewSettings |
Sets the Site Source directory, the directory where Jekyll will read files (defaults to `./`).
-s, --source DIR
Requires the Cake.Jekyll addin
|
SetWorkingDirectory |
JekyllNewSettings |
Sets the working directory which should be used to run the Jekyll command.
Requires the Cake.Jekyll addin
|
SkipBundle |
JekyllNewSettings |
Sets if `bundle install` should be skipped.
--safe
Requires the Cake.Jekyll addin
|
ThrowIfNull |
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 |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
Returns the string value or a
Not set > markup suitable for Spectre.Console.
From StringExtensions
Requires the Cake.Issues addin
|
WithPlugins |
JekyllNewSettings |
Sets the Plugins directory instead of using `_plugins/` automatically.
-p, --plugins DIR1[,DIR2,...]
Requires the Cake.Jekyll addin
|