Repolode
Submit
iamgio

iamgio/quarkdown

A Markdown-based typesetting system with function calls that compiles one source into books, papers, slides, websites, or wikis.

Open-source alternative to:LaTeXNotion

View on GitHubWebsite
Stars
16,347
Forks
523
Open issues
21
Last commit
2 days ago

What is it?

Quarkdown is a Markdown-based typesetting system that extends CommonMark and GFM with function calls, variables, and a standard library for layout, math, I/O, and conditionals. A single project can compile into a print-ready paged document, an academic paper, a continuous knowledge base, an interactive reveal.js presentation, or a documentation site.

Output targets include HTML (plain, paged, slides, and docs modes), PDF, GFM Markdown, and plain text. The document type is chosen with a .doctype function inside the source. Live preview combined with watch mode recompiles the source as files change, and a project wizard helps set up new documents.

Quarkdown runs a restrictive permission system that limits access to system resources. Editor support is available for VS Code, and unofficial plugins exist for IntelliJ IDEA and Vim.

Key features

  • 01Adds function calls, variables, and scripting to Markdown syntax.
  • 02Compiles one source to HTML, PDF, GFM Markdown, or plain text.
  • 03Offers four HTML document types: plain, paged, slides, and docs.
  • 04Provides live preview with watch-mode recompilation.
  • 05Includes a standard library for layout builders, math, I/O, and conditionals.
  • 06Restricts access to system resources by default.

Use cases

  • Writing academic papers or books that need print-ready PDF output from Markdown.
  • Building slide decks that are interactive and generated from text sources.
  • Maintaining a technical documentation site or personal knowledge base.
  • Reusing repeated content across documents through one-line function calls.

Quick start

  1. 1

    Install with Homebrew (Linux/macOS)

    brew install quarkdown-labs/quarkdown/quarkdown
  2. 2

    Create a new project with the setup wizard

    quarkdown create [directory]
  3. 3

    Compile your root source file

    quarkdown c file.qd

Things to know

  • Licensed under GPL-3.0, a copyleft license that requires derivative works to be distributed under the same terms.
  • Manual installs need a separate Chromium-family browser for PDF export.

In collections

PDF, OCR & document toolsCompilers, transpilers & programming languagesStatic site generators & documentation tools

Topics

#markdown#typesetting#static-site-generator#pdf#presentations#knowledge-management#kotlin#documentation#compiler#markup

FAQ

What is quarkdown?
A Markdown-based typesetting system with function calls that compiles one source into books, papers, slides, websites, or wikis. Quarkdown is a Markdown-based typesetting system that extends CommonMark and GFM with function calls, variables, and a standard library for layout, math, I/O, and conditionals. A single project can compile into a print-ready paged document, an academic paper, a continuous knowledge base, an interactive reveal.js presentation, or a documentation site.
Is quarkdown free to use? What license does it have?
quarkdown is open source under the GPL-3.0 license. Check the license terms before using it in commercial products.
Is quarkdown still maintained?
Actively maintained. The last commit to quarkdown was on Nov 5, 2026.
What can I use quarkdown for?
Writing academic papers or books that need print-ready PDF output from Markdown. Building slide decks that are interactive and generated from text sources. Maintaining a technical documentation site or personal knowledge base. Reusing repeated content across documents through one-line function calls.
How do I install quarkdown?
Install with Homebrew (Linux/macOS): brew install quarkdown-labs/quarkdown/quarkdown Create a new project with the setup wizard: quarkdown create [directory] Compile your root source file: quarkdown c file.qd
Where can I get quarkdown?
The source code and installation instructions are on GitHub: https://github.com/iamgio/quarkdown

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects