# Quarkdown Documents

Writes Quarkdown .qd documents that compile to HTML, PDF, or plain text.

- Repository: https://github.com/iamgio/quarkdown (16345 stars)
- Category: Documents
- License: GPL-3.0
- Last updated: 2026-11-01
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add iamgio/quarkdown --skill quarkdown -g -a claude-code -y`
Codex: `npx skills add iamgio/quarkdown --skill quarkdown -g -a codex -y`
Cursor: `npx skills add iamgio/quarkdown --skill quarkdown -g -a cursor -y`
Gemini CLI: `npx skills add iamgio/quarkdown --skill quarkdown -g -a gemini-cli -y`

## Description

Author Quarkdown (.qd) documents, a Markdown-superset typesetting language that compiles to HTML, PDF, or plaintext. Use when the user wants to write or edit .qd files, produce typeset output (articles, reports, slides, books, wikis, notes, static sites) beyond what plain Markdown offers, or share structured plans in a presentation-ready format. Quarkdown adds function calls (`.func {arg}`), variables, layouts, math, diagrams, and document types (plain/paged/slides/docs).

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# Quarkdown

Quarkdown is a Markdown flavor and typesetting system. It compiles `.qd` source files to HTML, PDF, or plaintext, extending CommonMark/GFM with function calls, variables, layouts, math, custom themes, and document types. Think of it as a more readable LaTeX.

## When to use

Use this skill when the user wants to write or edit a `.qd` file, or asks for typeset output (PDF, slides, paged article, themed wiki) instead of plain Markdown. Also when they want a polished, shareable version of a plan or report.

Do **not** use it when plain Markdown is the final target (chat, READMEs, GitHub issues).

## New projects

If the user wants to start a new Quarkdown project, tell them to run `quarkdown create [dir]` themselves. It's an interactive wizard that prompts for values. Don't scaffold project files by hand.

## Locating the bundled docs

Quarkdown ships a full offline copy of its wiki and stdlib API reference. Resolve the install dir once:

```bash
QUARKDOWN_INSTALL="$(quarkdown doctor get install-dir)"
```

Resources under `$QUARKDOWN_INSTALL`:

- `docs/wiki/_nav.qd`: wiki index. Start here to find pages by topic.
- `docs/wiki/*.qd`: individual wiki pages.
- `docs/wiki/quickstart.qd`: read this first if you are new to Quarkdown.
- `docs/quarkdown-stdlib/`: stdlib API reference (function signatures, parameters, return types) as HTML.

Read the relevant wiki pages before writing anything non-trivial.

## Workflow

The rest: https://github.com/iamgio/quarkdown/blob/HEAD/skills/quarkdown/SKILL.md