PipelineOptions

data class PipelineOptions(val prettyOutput: Boolean = false, val wrapOutput: Boolean = true, val workingDirectory: File? = null, val enableMediaStorage: Boolean = true, val serverPort: Int? = null, val mediaStorageOptionsOverrides: MediaStorageOptions = ReadOnlyMediaStorageOptions(), val errorHandler: PipelineErrorHandler = BasePipelineErrorHandler())

Read-only settings that affect different behaviors of a Pipeline.

Parameters

prettyOutput

whether the rendering stage should produce pretty output code

wrapOutput

whether the rendered code should be wrapped in a template code. For example, an HTML wrapper may add <html><head>...</head><body>...</body></html>, with the actual content injected in body

workingDirectory

the starting directory to use when resolving relative paths from function calls

enableMediaStorage

whether media storage should be enabled. If enabled, media objects referenced in the document are copied to the output directory and those elements that use them (e.g. images) automatically reference the new local path. This doesn't take effect with the base Markdown flavor, as the media architecture is defined by Quarkdown through a com.quarkdown.core.context.hooks.MediaStorerHook. If this is disabled, MediaStorageOptions are ignored.

mediaStorageOptionsOverrides

rules that override the default behavior of the media storage system

errorHandler

the error handler strategy to use when an error occurs in the pipeline, during the processing of a Quarkdown file

serverPort

port to communicate with the local server on. If not set, no server communication is performed. In a practical scenario, this is injected into JavaScript to communicate with the server, for example to enable dynamic reloading.

Constructors

Link copied to clipboard
constructor(prettyOutput: Boolean = false, wrapOutput: Boolean = true, workingDirectory: File? = null, enableMediaStorage: Boolean = true, serverPort: Int? = null, mediaStorageOptionsOverrides: MediaStorageOptions = ReadOnlyMediaStorageOptions(), errorHandler: PipelineErrorHandler = BasePipelineErrorHandler())

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val prettyOutput: Boolean = false
Link copied to clipboard
val serverPort: Int? = null
Link copied to clipboard

Whether the pipeline could communicate with a server. If false, no server communication is performed.

Link copied to clipboard
val workingDirectory: File? = null
Link copied to clipboard
val wrapOutput: Boolean = true