CLI: Webserver

Quarkdown's webserver allows direct communication between the compiler and the browser, enabling automatic content reloading.

The server can be started via quarkdown start.

Important

A webserver is mandatory in order to show paged documents, because of a paged.js requirement.
For that purpose, you can also use other webservers, such as Visual Studio Code's Live Preview, if you prefer.

Tip

quarkdown c ... -p is shorthand for quarkdown c ... && quarkdown start -f <generated file> -o

Options

• -f <file> or --file <file>: (mandatory) the file the server should point to. It would preferably be the output directory of the compilation.

• -p <port> or --port <port>: the webserver's port. If unset, defaults to 8089.

• -o or --open: if set, opens the target file in the default browser.