iamgio/quarkdown
Quarkdown
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.
Features
- Document Compilers - Implements a programmable compiler that uses functions, variables, and logic scripts to generate dynamic document layouts.
- Export Formats - Transforms a single markdown source into diverse outputs such as books, academic papers, and presentations.
- Print-Ready Exports - Provides specialized export processes for producing professionally formatted books and academic papers.
- Web-to-PDF Converters - Exports formatted documents to PDF or HTML using paged layouts and slide frameworks.
- Markdown Abstract Syntax Trees - Implements a parser that transforms markdown source into abstract syntax trees for structured manipulation.
- PDF Export Engines - Converts markdown source into professional books and academic papers with paged layouts.
- Single-Source Publishing Tools - Implements a single-source publishing workflow to transform markdown into books, papers, and presentations.
- Static Site Generators - Transforms markdown source files into static HTML, PDF, and academic formats using a command-line interface.
- Dynamic Document Generators - Enables the generation of layouts using functions, variables, loops, and conditional statements within markdown.
- File Renderers - Provides a command-line interface utility for converting markdown source files into target output formats.
- Document Export Pipelines - Transforms a single internal representation into multiple output formats including PDF, HTML, and professional print layouts.
- Page Layout Templates - Maps structured content onto specific format definitions to produce academic papers, books, or slide decks.
- Build-Time Logic Evaluation - Allows the use of functions, variables, loops, and conditional logic within markdown files to generate content at build time.
- AI Agent Integrations - Offers a mechanism for delivering offline wiki pages and API references to AI agents for improved accuracy.
- AI Knowledge Management - Prepares structured offline documentation and API references to be used as context for AI agents.
- Agent Knowledge Formats - Provides a specialized documentation format to supply offline wiki pages and API references to AI agents.
- Document Logic Prototyping - Allows testing of document functions and syntax in real time via a REPL before final compilation.
- Interactive REPLs - Includes an interactive read-eval-print loop for real-time execution and testing of document functions.
- Project Initializers - Ships a prompt-based wizard for creating project directories and generating initial metadata.
- Technical Writing Workflows - Facilitates a technical writing workflow utilizing a CLI and project initialization wizard.
- Project Initializers - Provides a guided wizard to bootstrap new project directories with standardized configuration and metadata.
- Extensii pentru editor - Processes markdown documents for fast rendering.
