JekyllServeSettingsExtensions Class

Summary

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

Syntax

public static class JekyllServeSettingsExtensions

Methods

Name Value Summary
Detach(JekyllServeSettings, Nullable<bool>) JekyllServeSettings
Sets if the the server should be detached from the terminal.
static
DisableDiskCache(JekyllServeSettings, bool) JekyllServeSettings
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(JekyllServeSettings, Nullable<bool>) JekyllServeSettings
Specifies if Bundler should not be used to execute Jekyll. `jekyll` instead of `bundle exec`...
static
EnableIncrementalBuild(JekyllServeSettings, bool) JekyllServeSettings
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(JekyllServeSettings, bool) JekyllServeSettings
Sets if a Liquid rendering profile should be generated. --profile Liquid rendering profile helps you identify performance bottlenecks.
static
EnableSafeMode(JekyllServeSettings, bool) JekyllServeSettings
Sets if both non-whitelisted plugins and caching to disk should be disabled, and if symbolic links should be ignore. --safe
static
EnableTrace(JekyllServeSettings, bool) JekyllServeSettings
Sets if the full backtrace should be shown when an error occurs. -t, --trace
static
EnableWatch(JekyllServeSettings, bool) JekyllServeSettings
Sets if auto-regeneration of the site when files are modified be enabled. -w, --[no-]watch
static
ForcePolling(JekyllServeSettings, bool) JekyllServeSettings
Sets if polling should be used when watching for changes. --force_polling
static
LimitPosts(JekyllServeSettings, Nullable<int>) JekyllServeSettings
Sets a limit to the number of posts to parse and publish. --limit_posts NUM
static
OpenUrl(JekyllServeSettings, Nullable<bool>) JekyllServeSettings
Sets if the site's URL should be open in the browser.
static
PublishFuture(JekyllServeSettings, bool) JekyllServeSettings
Sets if posts or collection documents with a future date should be published. --future
static
RenderDrafts(JekyllServeSettings, bool) JekyllServeSettings
Sets if posts in the `_drafts` folder should be processed and rendered. -D, --drafts
static
RenderUnpublished(JekyllServeSettings, bool) JekyllServeSettings
Sets if posts that were marked as unpublished should be rendered. --unpublished
static
SetBaseUrl(JekyllServeSettings, string) JekyllServeSettings
Sets the base URL to serve the website from. -b, --baseurl URL
static
SetDestination(JekyllServeSettings, DirectoryPath) JekyllServeSettings
Sets the Site Destination directory (defaults to ./_site). -d, --destination DIR
static
SetHostname(JekyllServeSettings, string) JekyllServeSettings
Sets the local server hostname to listen at.
static
SetLayouts(JekyllServeSettings, DirectoryPath) JekyllServeSettings
Sets the layout directory instead of using `_layouts/` automatically --layouts DIR
static
SetLiveReloadMaxDelay(JekyllServeSettings, TimeSpan) JekyllServeSettings
Sets the maximum delay before automatically reloading page.
static
SetLiveReloadMinDelay(JekyllServeSettings, TimeSpan) JekyllServeSettings
Sets the minimum delay before automatically reloading page.
static
SetLiveReloadPort(JekyllServeSettings, Nullable<int>) JekyllServeSettings
Sets the port for LiveReload to listen on.
static
SetLogLevel(JekyllServeSettings, Nullable<JekyllLogLevel>) JekyllServeSettings
Sets the log level which should be used to run the Jekyll command.
static
SetPort(JekyllServeSettings, Nullable<int>) JekyllServeSettings
Sets the local server port to listen on.
static
SetSource(JekyllServeSettings, DirectoryPath) JekyllServeSettings
Sets the Site Source directory, the directory where Jekyll will read files (defaults to `./`). -s, --source DIR
static
SetWorkingDirectory(JekyllServeSettings, DirectoryPath) JekyllServeSettings
Sets the working directory which should be used to run the Jekyll command.
static
ShowDirListing(JekyllServeSettings, Nullable<bool>) JekyllServeSettings
Sets if a directory listing should be shown instead of loading your index file.
static
SkipInitialBuild(JekyllServeSettings, Nullable<bool>) JekyllServeSettings
Sets if the initial site build which occurs before the server is started should be skipped.
static
UseLiveReload(JekyllServeSettings, Nullable<bool>) JekyllServeSettings
Sets if a page shoud be reloaded automatically on the browser when its content is edited.
static
UseLsi(JekyllServeSettings, bool) JekyllServeSettings
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
UseSslCertificate(JekyllServeSettings, FilePath) JekyllServeSettings
Sets the X.509 (SSL) Public Certificate, stored or symlinked in the site source.
static
UseSslKey(JekyllServeSettings, FilePath) JekyllServeSettings
Sets the X.509 (SSL) Private Key, stored or symlinked in the site source.
static
UseStrictFrontMatter(JekyllServeSettings, bool) JekyllServeSettings
Sets if the build should fail if there is a YAML syntax error in a page's front matter. --strict_front_matter
static
WithConfiguration(JekyllServeSettings, FilePath[]) JekyllServeSettings
Specifies one or more configuration file(s) instead of using `_config.yml` automatically. Settings in later files override settings in earlier files.
static
WithLiveReloadIgnore(JekyllServeSettings, string[]) JekyllServeSettings
Sets the file glob patterns for LiveReload to ignore.
static
WithPlugins(JekyllServeSettings, DirectoryPath[]) JekyllServeSettings
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
Requires the Cake.Issues addin