quarkdown-cli/com.quarkdown.cli/CliOptions

CliOptions

data class CliOptions(val source: File?, val outputDirectory: File?, val libraryDirectory: File?, val rendererName: String, val clean: Boolean, val pipe: Boolean, val nodePath: String, val npmPath: String, val exportPdf: Boolean = false, val noPdfSandbox: Boolean = false, val timeoutSeconds: Int? = null)

Options that affect the behavior of the Quarkdown CLI, especially I/O. For pipeline-related options, see com.quarkdown.core.pipeline.PipelineOptions.

Parameters

source

main source file to process

outputDirectory

the output directory to save resource in, if set

libraryDirectory

the directory to load .qd library files from. Defaults to lib/qd within the install layout

rendererName

name of the renderer to use to generate the output for

clean

whether to clean the output directory before generating new files

pipe

whether to output the rendered result to standard output, suitable for piping

nodePath

path to the Node.js executable

npmPath

path to the npm executable

exportPdf

whether to generate a PDF file

noPdfSandbox

whether to disable the Chrome sandbox for PDF export

timeoutSeconds

maximum time, in seconds, allowed for the pipeline execution to complete. null (default) or non-positive disables the timeout and runs the pipeline inline on the current thread.

Constructors

CliOptions

constructor(source: File?, outputDirectory: File?, libraryDirectory: File?, rendererName: String, clean: Boolean, pipe: Boolean, nodePath: String, npmPath: String, exportPdf: Boolean = false, noPdfSandbox: Boolean = false, timeoutSeconds: Int? = null)