CliOptions

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

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

rendererName

name of the renderer to use to generate the output for

clean

whether to clean the output directory before generating new files

nodePath

path to the Node.js executable

npmPath

path to the npm executable

generatePdf

whether to generate a PDF file

noPdfSandbox

whether to disable the Chrome sandbox for PDF export

Constructors

Link copied to clipboard
constructor(source: File?, outputDirectory: File?, libraryDirectory: File?, rendererName: String, clean: Boolean, nodePath: String, npmPath: String, exportPdf: Boolean = false, noPdfSandbox: Boolean = false)

Properties

Link copied to clipboard
Link copied to clipboard
val exportPdf: Boolean = false
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val noPdfSandbox: Boolean = false
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The rendering target to generate the output for. For instance HTML or PDF.

Link copied to clipboard
Link copied to clipboard
val source: File?