iamgio /quarkdown

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

★ 16,385⑂ 525👁 37⑃ 509● 213▤ 50
KotlinGPL-3.0Created 2024-01-30quarkdown.com
Download: v2.7.0v2.7.0 ↓2.7.02026-10-29
+3
Daily
16,385
stars
525
forks
37
watchers
509
prs
213
issues
50
releases

README

Releases
  
  Latest
    |  
  Stable 
  
  


 Table of contents

1. About
2. Demo
3. Editor extensions
4. Targets
5. Comparison
6. Getting started
    1. Installation
    2. Quickstart
    3. Creating a project
    4. Compiling
7. Mock document
8. Contributing
9. Sponsors
10. Concept
11. License

 

 About

Quarkdown is a modern Markdown-based typesetting system designed for versatility. It allows a single project to compile seamlessly into a print-ready book, academic paper, knowledge base, or interactive presentation.
All through an incredibly powerful Turing-complete extension of Markdown, ensuring your ideas flow automatically into paper.

 


  
  Original credits: Attention Is All You Need




Born as an extension of CommonMark and GFM, the Quarkdown Flavor brings functions to Markdown, along with many other syntax extensions.



 This is a function call:
 
 .somefunction {arg1} {arg2}
     Body argument
 



Possibilities are unlimited thanks to an ever-expanding repository of packages and templates, and a solid standard library.

Not enough? You can still define your own functions and variables, all within Markdown.
You can even create awesome libraries for everyone to use.



 
 .function {greet}
     to from:
     Hello, .to from .from!

 .greet {world} from:{iamgio}
 
 Result: Hello, world from iamgio!



This out-of-the-box scripting support opens doors to complex and dynamic content that would be otherwise impossible
to achieve with vanilla Markdown.

Combined with live preview, :zap: fast compilation speed and great editor support, Quarkdown simply gets the work done,
whether it's an academic paper, book, knowledge base or interactive presentation.

 





 

In a nutshell, Quarkdown is...

- Familiar: built on the well-known Markdown syntax, for a flat learning curve
- Elegant: produces output that matches the quality of industry-leading tools
- Agent-friendly: comes with a built-in skill for idiomatic fluency of your coding agents (read the eval)
- Customizable: full control over document layout, aesthetics, and properties
- Community-driven: import packages and templates with a single line of code, or publish your own
- Secure by default: a restrictive permission system limits access to system resources
- Versatile: a single source compiles to multiple targets
- Reactive: low-latency live previews for rapid iteration. The official wiki (100+ subdocuments) compiles in ~2 seconds
- Reusable: repeated content can be turned into one-line function calls
- Easily deployable: set a CD workflow up in under 3 minutes (example)

 

---

Looking for something?

  
    Check out the wiki
  
  to get started and learn more about the language and its features!


---

 

 As simple as you expect...


  
  Inspired by: X-ray flashes from a nearby supermassive black hole accelerate mysteriously


 

...as complex as you need.


  


 Editor extensions

- VS Code
- IntelliJ IDEA (unofficial by @C

Top issues

Discussions

Latest release

v2.7.0 v2.7.0 2026-10-29
This release marks one of Quarkdown's most significant milestones towards becoming a mature, community-driven project!

 

 Added

 

 Packages & package manager

This release comes with Quarkdown's long-awaited package manager! You can browse the available packages in the new catalog.

A package, called _atom_, can be easily included into your document the same way you .include any other local Quarkdown file, with the special syntax @scope/name:version.

The officially maintained scope, @atoms, is a GitHub-hosted repository anyone can contribute to.

markdown
.inclu

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON