For the complete documentation index, see llms.txt. This page is also available as Markdown.

PDF export

When running Quarkdown’s compiler via quarkdown c, specifying the --pdf flag generates a PDF file.

• The content of the PDF matches exactly what the HTML output would render in the Chrome browser.
• All document types and features supported by the HTML target are also supported.

Requirements

To generate PDF files from HTML, a Chromium-family browser is required. The recommended one is chrome-headless-shell, a lightweight, headless-only build of Chrome, although a regular installation of Chrome, Chromium, or Edge works as well.

Package managers and install scripts already take care of this dependency. If you installed Quarkdown manually, run scripts/install-chrome.sh (or scripts\install-chrome.ps1 on Windows) from the installation directory, which downloads the recommended browser version and prints the path to set via the options below. Alternatively, point Quarkdown to any Chromium-family browser you already have.

Additional options

• --chrome-path <path>: Sets the path to the browser executable. Defaults to chrome-headless-shell.

• --pdf-no-sandbox: Disables the Chromium sandbox during PDF generation. This is potentially unsafe and should only be used when strictly needed. For instance, some Linux distributions do not support headless sandbox.

Environment variables

• QD_CHROME_PATH: Path to the browser executable, used when --chrome-path is not set.

Exporting manually (legacy way)

You can export an HTML artifact to PDF via the in-browser print feature (CTRL/CMD + P).

While paged (and plain) documents are print-ready, you need a few additional steps to save your slides document as PDF. Please refer to Reveal’s instructions to learn how to do so.