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
Extensions for
JekyllBuildSettings
.
- Assembly
- Cake
.Jekyll .dll - Namespace
- Cake
.Jekyll .Commands .Build - Base Types
-
- Object
graph BT
Type-->Base0["Object"]
Type["JekyllBuildSettingsExtensions"]
class Type type-node
Syntax
public static class JekyllBuildSettingsExtensions
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.
static
|
DoNotUseBundler |
JekyllBuildSettings |
Specifies if Bundler should not be used to execute Jekyll.
`jekyll` instead of `bundle exec`...
static
|
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
static
|
EnableLiquidProfile |
JekyllBuildSettings |
Sets if a Liquid rendering profile should be generated.
--profile
Liquid rendering profile helps you identify performance bottlenecks.
static
|
EnableSafeMode |
JekyllBuildSettings |
Sets if both non-whitelisted plugins and caching to disk should be disabled, and if symbolic links should be ignore.
--safe
static
|
EnableTrace |
JekyllBuildSettings |
Sets if the full backtrace should be shown when an error occurs.
-t, --trace
static
|
EnableWatch |
JekyllBuildSettings |
Sets if auto-regeneration of the site when files are modified be enabled.
-w, --[no-]watch
static
|
ForcePolling |
JekyllBuildSettings |
Sets if polling should be used when watching for changes.
--force_polling
static
|
LimitPosts |
JekyllBuildSettings |
Sets a limit to the number of posts to parse and publish.
--limit_posts NUM
static
|
PublishFuture |
JekyllBuildSettings |
Sets if posts or collection documents with a future date should be published.
--future
static
|
RenderDrafts |
JekyllBuildSettings |
Sets if posts in the `_drafts` folder should be processed and rendered.
-D, --drafts
static
|
RenderUnpublished |
JekyllBuildSettings |
Sets if posts that were marked as unpublished should be rendered.
--unpublished
static
|
SetBaseUrl |
JekyllBuildSettings |
Sets the base URL to serve the website from.
-b, --baseurl URL
static
|
SetDestination |
JekyllBuildSettings |
Sets the Site Destination directory (defaults to `./_site`).
-d, --destination DIR
static
|
SetLayouts |
JekyllBuildSettings |
Sets the layout directory instead of using `_layouts/` automatically
--layouts DIR
static
|
SetLogLevel |
JekyllBuildSettings |
Sets the log level which should be used to run the Jekyll command.
static
|
SetSource |
JekyllBuildSettings |
Sets the Site Source directory, the directory where Jekyll will read files (defaults to `./`).
-s, --source DIR
static
|
SetWorkingDirectory |
JekyllBuildSettings |
Sets the working directory which should be used to run the Jekyll command.
static
|
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.
static
|
UseStrictFrontMatter |
JekyllBuildSettings |
Sets if the build should fail if there is a YAML syntax error in a page's front matter.
--strict_front_matter
static
|
WithConfiguration |
JekyllBuildSettings |
Specifies one or more configuration file(s) instead of using `_config.yml` automatically.
Settings in later files override settings in earlier files.
static
|
WithPlugins |
JekyllBuildSettings |
Sets the Plugins directory instead of using `_plugins/` automatically.
-p, --plugins DIR1[,DIR2,...]
static
|
Extension Methods
Name | Value | Summary |
---|---|---|
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
|