Skip to content

CLI ‐ Webserver

Giorgio Garofalo edited this page Sep 1, 2025 · 2 revisions

Quarkdown's webserver allows direct communication between the compiler and the browser, making live previewing possible.

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.

Tip

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

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.

  • -b <browser> or --browser <browser>: optional browser to open the served page on.

Getting started [NEW!]

Documentation

CLI tools

Markdown enhancements

Functions

Setting up

Multi-file projects

Layout

Charts & diagrams

Scripting & control flow

Utilities

Slides

I/O

Native content

Value types

Built-in libraries

  • Paper: abstract, definitions, theorems, and more

Extra features

Inside Quarkdown

Clone this wiki locally