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

Summary

The settings to configure the run of AsciiDoctorJ.

Assembly

Cake.AsciiDoctorJ.dll

Namespace

Cake.AsciiDoctorJ

Base Types

ToolSettings

graph BT Type-->Base0["ToolSettings"] Type["AsciiDoctorJRunnerSettings"] class Type type-node

Syntax

public class AsciiDoctorJRunnerSettings : ToolSettings

Attributes

Type	Description
NullableContextAttribute
NullableAttribute

Constructors

Name	Summary
AsciiDoctorJRunnerSettings()	Initializes a new instance of the `AsciiDoctorJRunnerSettings` class.

Properties

Name	Value	Summary
Attributes	IDictionary<string, string>	Gets the list of attributes to set on the document. Default: []. corresponds to: -a, --attribute.
Backend	string	Gets or sets a value indicating whether to set output format backend. Default: html5. corresponds to: -b, --backend.
BaseDir	DirectoryPath	Gets or sets a value indicating the base directory containing the document and resources. Default: directory of source file. corresponds to: -B, --base-dir.
ClassPath	IList<DirectoryPath>	Gets the list of directories to add to the classpath. corresponds to: -cp, -classpath, --classpath.
Compact	bool	Gets or sets a value indicating whether to compact the output by removing blank lines. Default: false. corresponds to: -C, --compact.
DestinationDir	DirectoryPath	Gets or sets a value indicating the destination output directory. Default: Directory of source file. corresponds to: -D, --destination-dir.
DocType	Nullable<DocType>	Gets or sets a value indicating the document type to use when rendering output: [article, book, inline]. Default: article. corresponds to: -d, --doctype.
ERuby	Nullable<ERuby>	Gets or sets a value to specify eRuby implementation to render built-in templates: [erb, erubis]. Default: erb. corresponds to: -e, --eruby.
InputFiles	IList<FilePath>	Gets the list of input files to be processed.
LoadPath	IList<DirectoryPath>	Gets the list of directories to add to the $LOAD_PATH. corresponds to: -I, --load-path.
Output	FilePath	Gets or sets a value indicating the output file(default: based on input file path); use - to output to STDOUT. corresponds to: -o, --out-file.
Quiet	bool	Gets or sets a value indicating whether to suppress warnings. Default: false. corresponds to: -q, --quiet.
Require	IList<string>	Gets or sets a value indicating whether to require the specified library before executing the processor. corresponds to: -r, --require.
SafeMode	Nullable<SafeMode>	Gets or sets a value to set safe mode level explicitly: [unsafe, safe, server, secure]. Default: UNSAFE. corresponds to: -S, --safe-mode.
SectionNumbers	bool	Gets or sets a value indicating whether to auto-number section titles in the HTML backend. Default: false. corresponds to: -n, --section-numbers.
SuppressHeaderAndFooter	bool	Gets or sets a value indicating whether to suppress output of header and footer. Default: false. corresponds to: -s, --no-header-footer.
TemplateDir	DirectoryPath	Gets or sets a value indicating the directory containing custom render templates the override the built-in set. corresponds to: -T, --template-dir.
TemplateEngine	string	Gets or sets a value indicating the template engine to use for the custom render templates (loads gem on demand). corresponds to: -E, --template-engine.
TimingsMode	bool	Gets or sets a value indicating whether to enable timings mode. Default: false. corresponds to: -t, --timings.
Verbose	bool	Gets or sets a value indicating whether to enable verbose mode. Default: false. corresponds to: -v, --verbose.
Version	bool	Gets or sets a value indicating whether to display the version and runtime environment. Default: false. corresponds to: -V, --version.

Extension Methods