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.Wyam.

Summary

Contains settings used by WyamRunner.

Assembly

Cake.Wyam.dll

Namespace

Cake.Wyam

Base Types

DotNetCoreSettings

graph BT Type-->Base0["DotNetCoreSettings"] Type["WyamSettings"] class Type type-node

Syntax

public sealed class WyamSettings : DotNetCoreSettings

Constructors

Name	Summary
WyamSettings()

Properties

Name	Value	Summary
Assemblies	IEnumerable<string>	Adds references to multiple assemblies by name, file name, or globbing patterns.
Attach	bool	Pauses execution while waiting for a debugger to attach.
ConfigurationFile	FilePath	Gets or sets a value indicating the configuration file that should be used while running Wyam.
ContentTypes	IDictionary<string, string>	Specifies additional supported content types for the preview server.
IgnoreConfigHash	bool	Force evaluating the configuration file, even when no changes were detected.
IgnoreDefaultSources	bool	Ignores default NuGet sources like the NuGet Gallery.
InputPaths	IEnumerable<DirectoryPath>	Gets or sets a value indicating the input paths that should be used while running Wyam.
LogFilePath	FilePath	Gets or sets the path to the Wyam log file.
NoCache	bool	Gets or sets a value indicating whether to turn off the caching mechanism on all modules if `true`.
NoClean	bool	Gets or sets a value indicating whether to prevent cleaning of the output path on each execution if `true`.
NuGetPackages	IEnumerable<NuGetSettings>	Adds NuGet packages (downloading and installing them if needed).
NuGetSources	IEnumerable<string>	Specifies additional package sources to use.
OutputPath	DirectoryPath	Gets or sets a value indicating the output path that should be used while running Wyam.
OutputScript	bool	Gets or sets a value indicating whether to output the script at end of execution.
PackagesPath	DirectoryPath	Gets or sets the packages path to use.
Preview	bool	Gets or sets a value indicating whether to enable previewing of the generated content in built in web server.
PreviewForceExtensions	bool	Gets or sets a value indicating whether to enable forcing of using file extensions.
PreviewPort	int	Gets or sets a value indicating the port number to use for previewing.
PreviewRoot	DirectoryPath	The path to the root of the preview server, if not the output folder.
PreviewVirtualDirectory	DirectoryPath	Gets or sets a value indicating the virtual directory to use for the preview server.
Recipe	string	Gets or sets the recipe.
RootPath	DirectoryPath	Gets or sets the The folder (or config file) to use as the root.
Settings	IDictionary<string, object>	Gets or sets metadata settings.
Theme	string	Gets or sets the theme.
UpdatePackages	bool	Gets or sets a value indicating whether to enable updating of packages.
UseGlobalSources	bool	Toggles the use of the global NuGet sources.
UseLocalPackages	bool	Gets or sets a value indicating whether to use a local NuGet packages folder.
Verbose	bool	Gets or sets a value indicating whether to run in verbose mode.
VerifyConfig	bool	Compile the configuration but do not execute.
Watch	bool	Gets or sets a value indicating whether to enable watching of input folder for changes to files.

Extension Methods

Name	Value	Summary
Dump<WyamSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<WyamSettings>(WyamSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<WyamSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<WyamSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<WyamSettings>(string, string)	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<WyamSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin

WyamSettings Class

Summary

Syntax

Constructors

Properties

Extension Methods