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.Build.JekyllBuildCommand
.
- Assembly
- Cake
.Jekyll .dll - Namespace
- Cake
.Jekyll .Commands .Build - Base Types
-
- ToolSettings
- JekyllSettings
graph BT
Type-->Base0["JekyllSettings"]
click Base0 "/api/Cake.Jekyll/JekyllSettings"
Base0-->Base1["ToolSettings"]
Type["JekyllBuildSettings"]
class Type type-node
Syntax
public class JekyllBuildSettings : JekyllSettings
Constructors
Name | Summary |
---|---|
JekyllBuildSettings |
Initializes a new instance of the JekyllBuildSettings class.
|
Properties
Name | Value | Summary |
---|---|---|
BaseUrl | string |
Serve the website from the given base URL.
-b, --baseurl URL
|
Command | string |
Gets the command which should be run.
Inherited from JekyllSettings
|
Configuration | OneOrMoreFilePaths |
Specifies one or more configuration file(s) instead of using `_config.yml` automatically.
Settings in later files override settings in earlier files.
|
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.
|
DisableDiskCache | Nullable |
Disable caching of content to disk in order to skip creating a `.jekyll-cache` or similar
directory at the source to avoid interference with virtual environments and third-party
directory watchers. Caching to disk is always disabled in safe mode (defaults to
).
--disable-disk-cache
|
DoNotUseBundler | Nullable |
Gets or sets if Bundler should *not* be used to execute Jekyll (defaults to
).
`jekyll` instead of `bundle exec`...
Inherited from JekyllSettings
|
Drafts | Nullable |
Process and render draft posts in the `_drafts` folder (defaults to
).
-D, --drafts
|
ForcePolling | Nullable |
Force watch to use polling (defaults to
).
--force_polling
|
Future | Nullable |
Publish posts or collection documents with a future date (defaults to
).
--future
|
IncrementalBuild | Nullable |
Enable the experimental incremental build feature. Incremental build only re-builds posts
and pages that have changed, resulting in significant performance improvements for large sites,
but may also break site generation in certain cases (defaults to
).
-I, --incremental
|
Layouts | DirectoryPath |
Specifies layout directory instead of using `_layouts/` automatically.
--layouts DIR
|
LimitPosts | Nullable |
Limit the number of posts to parse and publish.
--limit_posts NUM
|
LiquidProfile | Nullable |
Generate a Liquid rendering profile to help you identify performance bottlenecks (defaults to
).
--profile
|
LogLevel | Nullable |
Log level which should be used to run the Jekyll build command.
-V, --verbose
or
-q, --quiet
|
Lsi | Nullable |
Produce an index for related posts using latent semantic indexing (LSI) for improved related posts (defaults to
).
Requires the classifier-reborn plugin.
--lsi
|
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.
|
Source | DirectoryPath |
Site Source directory, the directory where Jekyll will read files (defaults to `./`).
-s, --source DIR
|
StrictFrontMatter | Nullable |
Cause a build to fail if there is a YAML syntax error in a page's front matter (defaults to
).
--strict_front_matter
|
Trace | Nullable |
Show the full backtrace when an error occurs (defaults to
).
-t, --trace
|
Unpublished | Nullable |
Render posts that were marked as unpublished (defaults to
).
--unpublished
|
Watch | Nullable |
Enable auto-regeneration of the site when files are modified (defaults to
).
-w, --[no-]watch
|
Methods
Extension Methods
Name | Value | Summary |
---|---|---|
DisableDiskCache |
JekyllBuildSettings |
Sets if caching to disk in non-safe mode should be disabled.
--disable-disk-cache
Disable caching of content to disk in order to skip creating a `.jekyll-cache` or similar
directory at the source to avoid interference with virtual environments and third-party
directory watchers. Caching to disk is always disabled in safe mode.
Requires the Cake.Jekyll addin
|
DoNotUseBundler |
JekyllBuildSettings |
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
|
Enable |
JekyllBuildSettings |
Sets if the experimental incremental rebuilds should be enabled.
Incremental build only re-builds posts and pages that have changed, resulting in significant performance
improvements for large sites, but may also break site generation in certain cases.
-I, --incremental
Requires the Cake.Jekyll addin
|
EnableLiquidProfile |
JekyllBuildSettings |
Sets if a Liquid rendering profile should be generated.
--profile
Liquid rendering profile helps you identify performance bottlenecks.
Requires the Cake.Jekyll addin
|
EnableSafeMode |
JekyllBuildSettings |
Sets if both non-whitelisted plugins and caching to disk should be disabled, and if symbolic links should be ignore.
--safe
Requires the Cake.Jekyll addin
|
EnableTrace |
JekyllBuildSettings |
Sets if the full backtrace should be shown when an error occurs.
-t, --trace
Requires the Cake.Jekyll addin
|
EnableWatch |
JekyllBuildSettings |
Sets if auto-regeneration of the site when files are modified be enabled.
-w, --[no-]watch
Requires the Cake.Jekyll addin
|
ForcePolling |
JekyllBuildSettings |
Sets if polling should be used when watching for changes.
--force_polling
Requires the Cake.Jekyll addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
LimitPosts |
JekyllBuildSettings |
Sets a limit to the number of posts to parse and publish.
--limit_posts NUM
Requires the Cake.Jekyll addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
PublishFuture |
JekyllBuildSettings |
Sets if posts or collection documents with a future date should be published.
--future
Requires the Cake.Jekyll addin
|
RenderDrafts |
JekyllBuildSettings |
Sets if posts in the `_drafts` folder should be processed and rendered.
-D, --drafts
Requires the Cake.Jekyll addin
|
RenderUnpublished |
JekyllBuildSettings |
Sets if posts that were marked as unpublished should be rendered.
--unpublished
Requires the Cake.Jekyll addin
|
SetBaseUrl |
JekyllBuildSettings |
Sets the base URL to serve the website from.
-b, --baseurl URL
Requires the Cake.Jekyll addin
|
SetDestination |
JekyllBuildSettings |
Sets the Site Destination directory (defaults to `./_site`).
-d, --destination DIR
Requires the Cake.Jekyll addin
|
SetLayouts |
JekyllBuildSettings |
Sets the layout directory instead of using `_layouts/` automatically
--layouts DIR
Requires the Cake.Jekyll addin
|
SetLogLevel |
JekyllBuildSettings |
Sets the log level which should be used to run the Jekyll command.
Requires the Cake.Jekyll addin
|
SetSource |
JekyllBuildSettings |
Sets the Site Source directory, the directory where Jekyll will read files (defaults to `./`).
-s, --source DIR
Requires the Cake.Jekyll addin
|
SetWorkingDirectory |
JekyllBuildSettings |
Sets the working directory which should be used to run the Jekyll command.
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 |
From StringExtensions
Requires the Cake.Issues addin
|
UseLsi |
JekyllBuildSettings |
Sets if an index for related posts using latent semantic indexing (LSI) for improved related posts should be produced.
Requires the classifier-reborn plugin.
Requires the Cake.Jekyll addin
|
UseStrictFrontMatter |
JekyllBuildSettings |
Sets if the build should fail if there is a YAML syntax error in a page's front matter.
--strict_front_matter
Requires the Cake.Jekyll addin
|
WithConfiguration |
JekyllBuildSettings |
Specifies one or more configuration file(s) instead of using `_config.yml` automatically.
Settings in later files override settings in earlier files.
Requires the Cake.Jekyll addin
|
WithPlugins |
JekyllBuildSettings |
Sets the Plugins directory instead of using `_plugins/` automatically.
-p, --plugins DIR1[,DIR2,...]
Requires the Cake.Jekyll addin
|