Quarkdown icon

Quarkdown

Quarkdown is an open-source, Markdown-based typesetting system for creating papers, presentations, knowledge bases, and static websites. It supports a command-line workflow with live preview, HTML output, and PDF export.

Quarkdown

Overview

Quarkdown is a Markdown-based typesetting system for creating papers, presentations, knowledge bases, and static websites. It is presented as an open-source tool that combines writing in Markdown with additional document structure, layout, and publishing features.

The product is designed for a command-line workflow: create a project, edit a `.qd` file, compile it, and optionally preview changes live or export to PDF. The source material shows Quarkdown as a single tool for multiple document formats, including continuous notes, paged documents, slides, and docs-style sites.

Features

Markdown plus custom document logic

Write in Markdown, then use Quarkdown-specific syntax for functions, variables, containers, boxes, and reusable elements. The quickstart shows function calls with named and positional arguments and custom components built with `.function`.

HTML and PDF output

Compile to HTML and export to PDF from the command line. The quickstart shows `quarkdown c main.qd` for HTML output and `quarkdown c main.qd --pdf` for PDF export.

Reactive live preview

Preview changes live while you write. The quickstart says `-p -w` opens the browser automatically so you can see results as you edit.

Multiple document layouts

Choose from multiple document types for different publishing targets. The wiki lists `plain`, `paged`, `slides`, and `docs`, covering notes, page-based documents, presentations, and documentation sites.

Figures and equations

Control figures and equations with document-aware syntax. The quickstart documents image sizing, captions, standalone figures, and TeX formula syntax for inline and display math.

Agent-friendly workflow

Use the bundled agent skill and offline wiki for assisted authoring. The blog says Quarkdown ships with a skill for agents and an offline copy of its wiki and API reference for lookups.

Use cases

  • Academic and report writing

    Draft papers or reports in Markdown while still controlling page layout, figures, and formulas. The paged document type is positioned for traditional document output and PDF export.

  • Documentation and knowledge bases

    Build internal wikis, knowledge bases, or static documentation sites with a docs-style layout and sidebar navigation. The source positions this format as suitable for large knowledge bases and wikis.

  • Presentations and lectures

    Create slide decks or lecture materials without switching to a separate presentation tool. The slides document type is intended for interactive presentations and talks.

  • Notes and personal knowledge management

    Keep notes in a continuous-flow layout similar to note-taking apps such as Notion or Obsidian. The plain document type is described as suitable for knowledge management and web viewing.

  • Preview-to-publish workflows

    Iterate quickly with live preview and a CLI compile loop, then export the finished result to HTML or PDF. This suits users who want one source format for previewing and publishing.

Pros and Cons

Pros

  • Open-source and Markdown-based, which makes the writing model familiar to many users.
  • Supports several output styles, including plain notes, paged documents, slides, and documentation sites.
  • Includes live preview and command-line compilation for iterative writing.
  • Adds document-specific capabilities such as functions, variables, image sizing, figures, and TeX formulas.
  • Provides an agent skill and offline reference material to support AI-assisted authoring.

Cons

  • The collected pricing page is a 404, so hosted pricing, plans, or commercial packaging are not confirmed in the available sources.
  • The quickstart covers core usage, but the broader documentation in the supplied sources is partial, so some features and integrations are not verified here.

FAQ

What kinds of documents can Quarkdown create?

Quarkdown is designed for creating documents from Markdown with additional typesetting and layout features. The source highlights papers, presentations, knowledge bases, and static websites as intended outputs.

How do you start a new Quarkdown document?

The quickstart shows a command-line workflow: create a project with `quarkdown create`, edit the generated `.qd` file, then compile with `quarkdown c`. It also supports live preview with `-p -w` and PDF export with `--pdf`.

What document layouts does Quarkdown support?

The quickstart lists `plain`, `paged`, `slides`, and `docs` as document types. They correspond to continuous notes, paged documents, presentations, and documentation-style sites.

Does Quarkdown use plain Markdown or add more syntax?

The source indicates that Quarkdown builds on Markdown and includes GitHub Flavored Markdown extensions. It also adds its own functions, variables, figures, image sizing, and TeX formula syntax.

Is there pricing information available?

The homepage and blog describe Quarkdown as open source, but the pricing page in the collected sources is a 404, so no hosted pricing or plan details are confirmed here.

Quick Facts

Category
Typesetting system
Primary interface
Command-line workflow
Source domain
quarkdown.com
Document types
plain, paged, slides, docs
Output formats
HTML and PDF
License/positioning
Open-source