# iamgio/quarkdown

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/iamgio-quarkdown).**

10,074 stars · 259 forks · Kotlin · gpl-3.0

## Links

- GitHub: https://github.com/iamgio/quarkdown
- Homepage: https://quarkdown.com
- awesome-repositories: https://awesome-repositories.com/repository/iamgio-quarkdown.md

## Topics

`compiler` `knowledge-management` `markdown` `markup` `markup-language` `paper` `pdf` `presentations` `scripting-language` `slides` `static-site-generator` `typesetting` `typesetting-system`

## Description

Quarkdown is a programmable document compiler and markdown static site generator. It transforms markdown source files into structured outputs, serving as a tool for generating professional books, academic papers, and digital presentations.

The system distinguishes itself through a programmable layout engine that allows for the use of functions, variables, loops, and conditional logic within markdown files. It includes an interactive read-eval-print loop for testing these document functions and syntax in real time before final compilation. Additionally, it provides a specialized format for supplying offline wiki pages and API references as structured knowledge bases for AI agents.

The project covers a broad range of document generation capabilities, including multi-format export to PDF and HTML, print-ready formatting for academic publications, and a command-line interface for source file compilation. It also includes a project initialization wizard to establish standardized directory structures and metadata.

## Tags

### Content Management & Publishing

- [Document Compilers](https://awesome-repositories.com/f/content-management-publishing/content-processing-transformation/document-processing-conversion/document-processing-engines/document-compilers.md) — Implements a programmable compiler that uses functions, variables, and logic scripts to generate dynamic document layouts.
- [Export Formats](https://awesome-repositories.com/f/content-management-publishing/content-formats-exporting/export-formats.md) — Transforms a single markdown source into diverse outputs such as books, academic papers, and presentations. ([source](https://cdn.jsdelivr.net/gh/iamgio/quarkdown@main/README.md))
- [Print-Ready Exports](https://awesome-repositories.com/f/content-management-publishing/content-formats-exporting/export-formats/pdf-exports/print-ready-exports.md) — Provides specialized export processes for producing professionally formatted books and academic papers. ([source](https://quarkdown.com/docs))
- [Web-to-PDF Converters](https://awesome-repositories.com/f/content-management-publishing/content-processing-transformation/document-processing-conversion/document-processing-tools/format-conversion-toolkits/pdf-format-converters/web-to-pdf-converters.md) — Exports formatted documents to PDF or HTML using paged layouts and slide frameworks. ([source](https://cdn.jsdelivr.net/gh/iamgio/quarkdown@main/README.md))
- [Markdown Abstract Syntax Trees](https://awesome-repositories.com/f/content-management-publishing/content-processing-transformation/document-processing-conversion/document-processing/format-specific-parsers/markdown-abstract-syntax-trees.md) — Implements a parser that transforms markdown source into abstract syntax trees for structured manipulation.
- [PDF Export Engines](https://awesome-repositories.com/f/content-management-publishing/content-processing-transformation/markdown-markup-tools/markdown-tools/pdf-export-engines.md) — Converts markdown source into professional books and academic papers with paged layouts.
- [Single-Source Publishing Tools](https://awesome-repositories.com/f/content-management-publishing/single-source-publishing-tools.md) — Implements a single-source publishing workflow to transform markdown into books, papers, and presentations.
- [Static Site Generators](https://awesome-repositories.com/f/content-management-publishing/static-site-document-generators/static-site-generators.md) — Transforms markdown source files into static HTML, PDF, and academic formats using a command-line interface.

### Development Tools & Productivity

- [Dynamic Document Generators](https://awesome-repositories.com/f/development-tools-productivity/documentation-discovery-metadata/knowledge-documentation-management/documentation-knowledge-tools/documentation-generators/dynamic-document-generators.md) — Enables the generation of layouts using functions, variables, loops, and conditional statements within markdown. ([source](https://cdn.jsdelivr.net/gh/iamgio/quarkdown@main/README.md))
- [File Renderers](https://awesome-repositories.com/f/development-tools-productivity/file-renderers.md) — Provides a command-line interface utility for converting markdown source files into target output formats. ([source](https://cdn.jsdelivr.net/gh/iamgio/quarkdown@main/README.md))
- [Document Logic Prototyping](https://awesome-repositories.com/f/development-tools-productivity/interactive-prototyping/code-prototyping/document-logic-prototyping.md) — Allows testing of document functions and syntax in real time via a REPL before final compilation.
- [Interactive REPLs](https://awesome-repositories.com/f/development-tools-productivity/interactive-repls.md) — Includes an interactive read-eval-print loop for real-time execution and testing of document functions.
- [Project Initializers](https://awesome-repositories.com/f/development-tools-productivity/project-initializers.md) — Ships a prompt-based wizard for creating project directories and generating initial metadata. ([source](https://cdn.jsdelivr.net/gh/iamgio/quarkdown@main/README.md))
- [Technical Writing Workflows](https://awesome-repositories.com/f/development-tools-productivity/technical-writing-workflows.md) — Facilitates a technical writing workflow utilizing a CLI and project initialization wizard.
- [Project Initializers](https://awesome-repositories.com/f/development-tools-productivity/terminal-shell-cli/cli-tooling-frameworks/cli-tooling/project-lifecycle-orchestrators/project-initializers.md) — Provides a guided wizard to bootstrap new project directories with standardized configuration and metadata.

### Programming Languages & Runtimes

- [Document Export Pipelines](https://awesome-repositories.com/f/programming-languages-runtimes/source-code-compilers/multi-target-compilers/document-export-pipelines.md) — Transforms a single internal representation into multiple output formats including PDF, HTML, and professional print layouts.

### User Interface & Experience

- [Page Layout Templates](https://awesome-repositories.com/f/user-interface-experience/page-layout-templates.md) — Maps structured content onto specific format definitions to produce academic papers, books, or slide decks.

### Web Development

- [Build-Time Logic Evaluation](https://awesome-repositories.com/f/web-development/content-insertion-utilities/dynamic-content-insertion/build-time-logic-evaluation.md) — Allows the use of functions, variables, loops, and conditional logic within markdown files to generate content at build time.

### Artificial Intelligence & ML

- [AI Agent Integrations](https://awesome-repositories.com/f/artificial-intelligence-ml/ai-agent-integrations.md) — Offers a mechanism for delivering offline wiki pages and API references to AI agents for improved accuracy. ([source](https://quarkdown.com/blog/agent-skill/))
- [AI Knowledge Management](https://awesome-repositories.com/f/artificial-intelligence-ml/ai-knowledge-management.md) — Prepares structured offline documentation and API references to be used as context for AI agents.

### Data & Databases

- [Agent Knowledge Formats](https://awesome-repositories.com/f/data-databases/data-quality-frameworks/ai-knowledge-bases/agent-knowledge-formats.md) — Provides a specialized documentation format to supply offline wiki pages and API references to AI agents.

### Part of an Awesome List

- [Editor Extensions](https://awesome-repositories.com/f/awesome-lists/devtools/editor-extensions.md) — Processes markdown documents for fast rendering.
