iamgio

quarkdown

Other#Markdown#Typesetting#Documentation#CLI#Kotlin

// summary

Quarkdown is a modern, versatile typesetting system that extends Markdown with Turing-complete scripting capabilities. It enables users to compile projects into various formats, including print-ready books, academic papers, and interactive presentations. The platform supports live previews and provides a powerful CLI and VS Code extension to streamline the document creation process.

// technical analysis

Quarkdown is a modern, Turing-complete typesetting system that extends Markdown to support complex document generation, including books, academic papers, and interactive presentations. By introducing functional programming concepts directly into Markdown syntax, it solves the limitation of vanilla Markdown in handling dynamic content and sophisticated layouts. The project prioritizes versatility and developer experience, offering a robust standard library and live-preview capabilities to bridge the gap between simple text formatting and professional document control.

// key highlights

Integrates functional programming into Markdown, allowing users to define custom functions, variables, and logic directly within their documents.

Supports multiple output formats including HTML, PDF, and plain text, with specialized modes for paged documents, slides, and documentation wikis.

Provides a powerful standard library that includes layout builders, I/O operations, mathematical support, and control flow structures like loops and conditionals.

Features a dedicated VS Code extension that enables live previewing, significantly improving the feedback loop during the document creation process.

Offers a CLI-based project wizard that simplifies the initialization of new projects with pre-configured metadata and content structures.

Maintains high performance with fast compilation speeds, making it suitable for managing large-scale knowledge bases and technical documentation.

// use cases

Creating print-ready academic papers and books

Building interactive presentations and slide decks

Developing technical documentation and knowledge bases

// getting started

To begin, install Quarkdown using the provided shell or PowerShell scripts, or via Homebrew/Scoop. Once installed, use the 'quarkdown create [directory]' command to initialize a new project, and compile your documents using 'quarkdown c [file.qd]'. For an interactive experience, you can use 'quarkdown repl' or enable live preview with the '-p -w' flags.