quarkdown

🪐 Markdown with superpowers: from ideas to papers, presentations, websites, books, and knowledge bases.

24 articles 12.5k View on GitHub ↗
24 articles
How to Debug Performance Issues in Quarkdown's Pipeline Stages

Debug Quarkdown pipeline performance issues using PipelineHooks and MillisStopwatch for granular timings. Enable debug logging with -Dloglevel=debug for insights without production impact.

performance
Apr 29, 2026
How to Add Syntax Highlighting Support for New Languages in Quarkdown HTML

Easily add syntax highlighting for new languages in Quarkdown HTML by creating a custom entry file and updating the `bundleHighlightJs` Gradle task. Enhance your code documentation effortlessly.

how-to-guide
Apr 29, 2026
How Quarkdown Compiles .qd Files to HTML and PDF: A Deep Dive into the Pipeline

Deep dive into the Quarkdown compilation pipeline. Discover how .qd files transform into HTML and PDF via lexing, parsing, AST rendering, and optional PDF generation with Puppeteer.

deep-dive
Apr 29, 2026
How to Implement Custom Bibliography Styles in Quarkdown: CSL and Native Methods

Implement custom bibliography styles in Quarkdown using CSL files or Kotlin. Format your references with ease and tailor bibliographies to your specific needs.

how-to-guide
Apr 29, 2026
How Quarkdown Handles Cross-References Between Sections, Figures, and Tables

Discover how Quarkdown expertly manages cross-references for sections, figures, and tables. Learn about its AST node parsing, resolution, and hyperlink rendering for seamless document navigation within your project.

how-to-guide
Apr 29, 2026
How to Create Custom QuarkdownModule Definitions with Function Registrations in Quarkdown

Learn to create custom QuarkdownModule definitions with function registrations by writing Kotlin functions and grouping them using moduleOf. Load your module via MultiFunctionLibraryLoader.

how-to-guide
Apr 29, 2026
How DynamicValue Lazy Evaluation Works for Body Arguments in Quarkdown

Discover how Quarkdown uses DynamicValue lazy evaluation for body arguments. Learn how raw text is stored and Markdown AST is materialized only when needed, boosting performance.

internals
Apr 29, 2026
Quarkdown Language Server Protocol Implementation Architecture: A Deep Dive into the LSP-4J Design

Explore the Quarkdown Language Server Protocol implementation architecture. Discover its modular supplier-driven design built on LSP-4J and how it aggregates results efficiently.

architecture
Apr 29, 2026
How to Implement Custom Template Processors in Quarkdown's Project Creator

Learn to implement custom template processors in Quarkdown's project creator. Extend the create wizard by implementing ProjectCreatorTemplateProcessorFactory and registering your factory.

how-to-guide
Apr 29, 2026
How LivePreviewEndpoint Works with Puppeteer for PDF Generation in Quarkdown

Discover how Quarkdown's LivePreviewEndpoint leverages Puppeteer for PDF generation, reusing the static file server and a print query parameter for identical page rendering.

internals
Apr 29, 2026
How to Extend Quarkdown with New AST Nodes and NodeVisitor Implementations

Learn to extend Quarkdown by adding new AST nodes and NodeVisitor implementations in Kotlin. Enhance your Quarkdown renderer with custom components.

how-to-guide
Apr 29, 2026
How Context Forking Determines the Sandbox Level in Quarkdown

Discover how context forking in Quarkdown determines sandbox levels. Learn how it controls state mutations propagation across included files for isolation or read-only access.

deep-dive
Apr 29, 2026

Have a question about this repo?

These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:

Share the following with your agent to get started:
curl -s "https://instagit.com/install.md"

Works with
Claude Codex Cursor VS Code OpenClaw Any MCP Client

Maintain an open-source project? Get it listed too →