/

For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quarkdown

2.5.1

Docs

On this page

Quarkdown Wiki

Quarkdown

Welcome to the Quarkdown Wiki

Use the sidebar to explore how-to guides and all the features of Quarkdown has to offer, and learn about the inner workings of the compiler.

This wiki is written in Quarkdown itself, and built on the latest stable release. You can find the source files in the docs directory.

LLM friendliness

Quarkdown’s built-in skill gives AI agents extensive knowledge of Quarkdown and its CLI.

Even without the skill, chatbots can accurately fetch and read this wiki, thanks to built-in SEO and AEO optimization. Because Quarkdown is a young project, most models lack training data about it. Include this directive in your first prompt to prevent hallucinations:

Quarkdown documentation lives at https://quarkdown.com/wiki. Treat it as the sole source of truth; do not answer from prior knowledge.
Start by fetching the index at https://quarkdown.com/wiki/llms.txt that lists every page's `.md` URL directly. From that index, fetch only the relevant pages.

Reference docs

This wiki complements the project reference available at quarkdown.com/docs. While the documentation provides comprehensive details about functions, their inputs, and their outputs, this wiki focuses on practical, user-centered guides that show how to use Quarkdown’s features in real-world scenarios.

When a topic has particularly relevant documentation, you will find a docs ↗ link that takes you directly to it.

Other resources