Quarkdown

https://quarkdown.com/wiki
Admin
Quarkdown is an open-source typesetting system that extends Markdown with LaTeX-inspired features to...
Tokens:87,822
Snippets:1,082
Trust Score:7.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example 1: _setup.qd configuration

Source: https://quarkdown.com/wiki/docs-library.md

Example _setup.qd file with language, theme, and a page margin link. This file is included automatically by the library.

```markdown
.doclang {English}
.theme {darko} layout:{minimal}

.pagemargin {topright}
    [GitHub](https://github.com/iamgio/quarkdown)
```

--------------------------------

### Example 2: _nav.qd navigation

Source: https://quarkdown.com/wiki/docs-library.md

Example _nav.qd file with navigation links grouped by decorative headings. The current page is automatically highlighted in the sidebar.

```markdown
###! Getting started
- [Quickstart](quickstart.qd)

###! Topics
- [Page 1](page-1.qd)
- [Page 2](page-2.qd)
  - [Section A](page-2.qd#section-a)
```

--------------------------------

### Context sharing setup files

Source: https://quarkdown.com/wiki/including-other-quarkdown-files.md

Defines the source files used to demonstrate context sharing behavior.

```markdown
.docname {New name}

.function {greet}
  name:
  Hello, **.name**!
```

```markdown
.docname {My document}
.include {file.qd} sandbox:{<value>}

1. .docname
2. .greet {John}
```

--------------------------------

### Document setup inclusion

Source: https://quarkdown.com/wiki/including-other-quarkdown-files.md

Shows how to move document configuration into a separate setup.qd file and include it in the main document.

```markdown
.docname {My document}
.docauthor {iamgio}
.doctype {slides}
.doclang {English}
.theme {darko} layout:{minimal}

.footer
   ...
```

```markdown
.include {setup.qd}

# My cool document

...
```

--------------------------------

### Example 1: .text with variant, size, and decoration

Source: https://quarkdown.com/wiki/text.md

Shows a Markdown example using the .text function with the variant:{smallcaps} option in a heading and size:{large} decoration:{underoverline} in a paragraph. The rendered output is also displayed.

```markdown
##! A demo of .text {Quarkdown} variant:{smallcaps}

The .text {quick brown fox} size:{large} decoration:{underoverline} jumps over the lazy dog.
```

--------------------------------

### Initial document content example

Source: https://quarkdown.com/wiki/quickstart.md

The default content structure found in a newly created .qd file.

```diff
## Quickstart

- Welcome to [Quarkdown](https://quarkdown.com)!
- This is the starting point of your document.
- ...
```

--------------------------------

### Print install directory with quarkdown doctor get install-dir

Source: https://quarkdown.com/wiki/cli-doctor.md

Prints the absolute path of the Quarkdown install directory (root containing bin/, lib/, docs/). Useful for locating bundled resources from shell scripts.

```shell
quarkdown doctor get install-dir
```

--------------------------------

### Styled container example

Source: https://quarkdown.com/wiki/container.md

Example 4 demonstrates styling a container with parameters like `fullwidth`, `borderstyle`, `padding`, `fontsize`, `fontstyle`, and `fontvariant`. The container accepts all element styling options.

```markdown
.container fullwidth:{yes} borderstyle:{dashed} padding:{1cm} fontsize:{medium} fontstyle:{italic} fontvariant:{smallcaps}
    This is a styled container. Fancy, isn't it?

    Quarkdown can truly give life to complex layouts with ease.
```

--------------------------------

### Simple chaining example

Source: https://quarkdown.com/wiki/syntax-of-a-function-call.md

A simpler example of chaining to understand the transformation. The compiler transforms .myvar::uppercase into .uppercase {.myvar}.

```markdown
.myvar::uppercase
```

--------------------------------

### Define a basic function

Source: https://quarkdown.com/wiki/localization.md

An example of defining a simple .theorem function that displays a static string.

```markdown
.function {theorem}
    **Theorem.**

.theorem This is my theorem
```

--------------------------------

### Full example of custom numbered elements

Source: https://quarkdown.com/wiki/numbering.md

Demonstrates multiple numbered blocks using the 'greetings' key with a '1.a' format.

```markdown
.numbering
    - headings: 1.1
    - greetings: 1.a

## Title 1

.numbered {greetings}
    number:
    **Hello!** This block has the number **.number**

.numbered {greetings}
    number:
    **Hey!** This has instead the number **.number**

## Title 2

.numbered {greetings}
    number:
    **Hi!** Here we have the number **.number**
```

--------------------------------

### BibTeX Entry Examples

Source: https://quarkdown.com/wiki/bibliography.md

Example BibTeX entries for an article and a book.

```text
@article{einstein,
  author = "Albert Einstein",
  ...
}

@book{hawking,
  author = "Stephen Hawking",
  ...
}
```

--------------------------------

### Configure Code Block Numbering

Source: https://quarkdown.com/wiki/numbering.md

Example 6 demonstrates how to enable numbering for code blocks using the .numbering configuration.

```markdown
.numbering
    - code: 1

```python
def hello():
    print("Hello, world!")
```

```kotlin
fun main() {
    println("Hello, world!")
}
```
```

--------------------------------

### Markdown input example

Source: https://quarkdown.com/wiki/pipeline---rendering.md

Example Markdown input used to illustrate the rendering process. It includes a heading, bold and italic text, and a list.

```markdown
## Title

This is **bold** and _italic_ text.

- Item 1
- Item 2
```

--------------------------------

### Multi-line arguments example

Source: https://quarkdown.com/wiki/syntax-of-a-function-call.md

Shows a function call with arguments spanning multiple lines. The indentation is optional and arbitrary. The output of this example is -0.33333334.

```markdown
.divide {
    .cos {.pi}
} by:{
    .sum {2} {1}
}
```

--------------------------------

### Configure Equation Numbering with Cross-References

Source: https://quarkdown.com/wiki/numbering.md

Example 4 shows how to enable equation numbering using cross-reference IDs.

```markdown
.numbering
    - equations: (1)

$ E = mc^2 $ {#energy}

$ F = ma $ {#force}
```

--------------------------------

### Use install-dir in a shell script to list docs

Source: https://quarkdown.com/wiki/cli-doctor.md

Captures the install directory into a variable and lists its docs folder, avoiding manual binary path resolution.

```shell
INSTALL="$(quarkdown doctor get install-dir)"
ls "$INSTALL/docs"
```

--------------------------------

### Configure Table Numbering

Source: https://quarkdown.com/wiki/numbering.md

Example 3 demonstrates how to set table numbering to a decimal format using the .numbering configuration block.

```markdown
.numbering
    - headings: 1.A.a
    - tables: 1.1

## Title

|           | Age | Favorite food |
|-----------|-----|---------------|
| **Anne**  | 24  | Hamburger     |
| **Lucas** | 19  | Pizza         |
| **Joe**   | 32  | Sushi         |
"Study results."

### Title

|           | Age | Favorite food |
|-----------|-----|---------------|
| **Anne**  | 24  | Hamburger     |
| **Lucas** | 19  | Pizza         |
| **Joe**   | 32  | Sushi         |

## Title

|           | Age | Favorite food |
|-----------|-----|---------------|
| **Anne**  | 24  | Hamburger     |
| **Lucas** | 19  | Pizza         |
| **Joe**   | 32  | Sushi         |
```

--------------------------------

### Create a full-bleed cover page

Source: https://quarkdown.com/wiki/book-cover.md

This example demonstrates how to configure the first page of a document to have no margins and a full-width image.

```markdown
.doctype {paged}

.pageformat pages:{..1} margin:{0}

.container fullwidth:{yes} margin:{0}
    !(100%)[Cover](cover.png)

# Introduction

...
```

--------------------------------

### Inline content example with .box

Source: https://quarkdown.com/wiki/markdown-content.md

Shows how to pass inline content to a function like .box. The content includes text and emphasis.

```markdown
.box {My _box_ title}
    ...
```

--------------------------------

### Example 2: Function definition and usage with .sourceresult

Source: https://quarkdown.com/wiki/typing.md

Defines a function 'sourceresult' that takes a 'source' argument, displays it as code via .code, and also parses it as Markdown content. The example shows the function definition, the source passed to it, and the resulting rendered output.

```markdown
.function {sourceresult}
    source:
    .code {markdown}
        .source
    .source

.sourceresult
    ##! Quarkdown 

    Quarkdown was born in **.sum {2000} {24}**

```

```markdown
##! Quarkdown 

Quarkdown was born in **.sum {2000} {24}**

```

--------------------------------

### Example 3: Override sidebar positions

Source: https://quarkdown.com/wiki/docs-library.md

Override the default sidebar positions by setting pagelistposition and tocposition variables in _setup.qd. This example swaps the left and right sidebars.

```markdown
.theme {darko}

.pagelistposition {righttop}
.tocposition {lefttop}
```

--------------------------------

### Markdown decorative heading example

Source: https://quarkdown.com/wiki/decorative-headings.md

Shows a markdown example with a decorative heading '#!' that is not numbered and not in the table of contents, followed by a regular heading and a loremipsum placeholder.

```markdown
```markdown
.center
    #! My document

## Introduction

.loremipsum
```
```

--------------------------------

### Custom figure syntax example

Source: https://quarkdown.com/wiki/custom-figure.md

Demonstrates the use of .figure with a caption and a nested container block.

```markdown
.figure caption:{My caption.}
    .container padding:{1cm} background:{teal}
        Hello, world!
```

--------------------------------

### Em-dash replacement example

Source: https://quarkdown.com/wiki/text-symbols.md

Demonstrates the automatic replacement of double hyphens with an em-dash.

```markdown
"Quarkdown"--a typesetting system--supports automatic text replacements.
```

--------------------------------

### Mixed positional and named arguments

Source: https://quarkdown.com/wiki/syntax-of-a-function-call.md

An example demonstrating how to mix positional and named arguments. Note that all arguments following a named argument must also be named.

```markdown
.multiply {6} by:{3}
```

--------------------------------

### Block content example with .center

Source: https://quarkdown.com/wiki/markdown-content.md

Shows how to pass block content to a function like .center. Includes a heading, paragraph, blockquote, and a nested .row function call.

```markdown
.center
    # My centered title

    This is a paragraph in a **centered** block!

    > This is a _blockquote_.
    >
    > It spans over multiple sub-paragraphs.

    <!-- A nested block function call -->
    .row
        ...
```

--------------------------------

### HTML output example

Source: https://quarkdown.com/wiki/pipeline---rendering.md

The HTML output generated from the Markdown input, showing the translation of the AST into HTML elements.

```html
<h1>Title</h1>
<p>This is <strong>bold</strong> and <em>italic</em> text.</p>
<ul>
  <li>Item 1</li>
  <li>Item 2</li>
</ul>
```

--------------------------------

### Grid with columns and alignment

Source: https://quarkdown.com/wiki/stacks.md

Example 4: A .grid stack with 2 columns and spacearound alignment, containing four blocks: A, *B*, **C**, and ***D***.

```markdown
.grid columns:{2} alignment:{spacearound}
    A

    *B*

    **C**

    ***D***

```

--------------------------------

### Apply paragraph style with lineheight, spacing, and indent

Source: https://quarkdown.com/wiki/paragraph-style.md

Example of using .paragraphstyle to set specific line height, paragraph spacing, and indentation values.

```markdown
.paragraphstyle lineheight:{2.5} spacing:{0} indent:{2}
```

--------------------------------

### Declaring only used parameters in .extend

Source: https://quarkdown.com/wiki/extending-functions.md

All wrapper parameters are optional; you only need to declare the ones you use. This example only declares 'name' and uppercases it, leaving other parameters unchanged.

```markdown
.function {greet}
    greeting name surname:
    .greeting, .name .surname!

.extend {greet}
    name:
    .super name:{.name::uppercase}

.greet {Hello} name:{John} surname:{Doe}
```

```text
Hello, JOHN Doe!
```

--------------------------------

### Reset page number

Source: https://quarkdown.com/wiki/page-counter.md

Example showing how to use .resetpagenumber to set the page number to 20 starting from the third page.

```markdown
.pagemargin {topcenter}
    .currentpage

# First page

# Second page

.resetpagenumber start:{20}

# Third page
```

--------------------------------

### Define setup.qd

Source: https://quarkdown.com/wiki/quickstart.md

Configuration file containing document metadata and formatting settings.

```markdown
.docname {MyDocument}
.doctype {paged}
.doclang {English}
.theme {paperwhite} layout:{latex}

.docauthors
    - Quarkdown

.pagemargin {bottomright}
    .currentpage / .totalpages

.numbering
    - headings: 1.1.1
    - figures: 1.1

.extend {heading}
    ...
```

--------------------------------

### Format page numbers

Source: https://quarkdown.com/wiki/page-counter.md

Example showing how to use .formatpagenumber to change the numbering style to lowercase roman numerals starting from the second page.

```markdown
.pagemargin {topcenter}
    .currentpage

# First page

.formatpagenumber {i}

# Second page

# Third page
```

--------------------------------

### Composed row and column stacks

Source: https://quarkdown.com/wiki/stacks.md

Example 5: A .row stack with spacearound alignment containing two .column stacks, each with a name, company, and email link.

```markdown
.row alignment:{spacearound}
    .column
        **Michael Scott**

        Dunder Mifflin Paper Company, Inc.

        [michaelscott@example.com](mailto:michaelscott@example.com)

    .column
        **Forrest Gump**

        Bubba Gump Shrimp Co.

        [forrestgump@example.com](mailto:forrestgump@example.com)

```

--------------------------------

### Include files in my-document.qd

Source: https://quarkdown.com/wiki/quickstart.md

Demonstrates replacing document content with .include directives for setup.qd and content.qd.

```diff
- .docname {Quickstart}
- .doctype {paged}
- .doclang {English}
- .theme {paperwhite} layout:{latex}
-
- .docauthors
-     - ...
-
- .pagemargin {bottomright}
-     .currentpage / .totalpages
-
- .pagemargin {bottomleft}
-     .lastheading depth:{1}
-
- .numbering
-     - headings: 1.1.1
-     - figures: 1.1
-
- .extend {heading}
-     ...

+ .include {setup.qd}
+ .include {content.qd}

- .tableofcontents
-
- # Quickstart
-
- ...
```

--------------------------------

### Float an image with alignment start

Source: https://quarkdown.com/wiki/float.md

Use .float {start} to float an image to the start (left) and allow text to wrap around it. The image is included with the !(70%)[Icon](assets/icon.svg) syntax.

```markdown
.float {start}
    !(70%)[Icon](assets/icon.svg)

.loremipsum
```

--------------------------------

### Positional argument example

Source: https://quarkdown.com/wiki/syntax-of-a-function-call.md

An example of a function call using positional arguments.

```markdown
.multiply {6} {3}
```

--------------------------------

### Launch live preview

Source: https://quarkdown.com/wiki/quickstart.md

Uses the -p and -w flags to enable live preview and file watching.

```shell
quarkdown c main.qd -p -w
```

--------------------------------

### Chaining with variable declaration example

Source: https://quarkdown.com/wiki/syntax-of-a-function-call.md

Declares a variable and then uses chaining to call a function on it. The output of this example is HELLO!.

```markdown
.var {myvar} {hello!}

.myvar::uppercase
```

--------------------------------

### Markdown inline elements example

Source: https://quarkdown.com/wiki/pipeline---lexing.md

Example of markdown syntax representing inline-level elements like bold and italics.

```markdown
A **formatted** _text_.
```

--------------------------------

### Markdown block elements example

Source: https://quarkdown.com/wiki/pipeline---lexing.md

Example of markdown syntax representing block-level elements like headings, paragraphs, quotes, and lists.

```markdown
# A heading

A paragraph

> A quote

- A list
- of multiple items
```

--------------------------------

### Include an external file

Source: https://quarkdown.com/wiki/including-other-quarkdown-files.md

Demonstrates how to include the content of file.qd into main.qd.

```markdown
### Hello Quarkdown

This is external content.
```

```markdown
.include {file.qd}
```

--------------------------------

### Nested function calls example

Source: https://quarkdown.com/wiki/syntax-of-a-function-call.md

Shows a function call nested within an argument to compose a complex expression. The output of this example is 28.274334.

```markdown
.multiply {.pow {3} to:{2}} by:{.pi}
```

--------------------------------

### Initialize Bibliography

Source: https://quarkdown.com/wiki/bibliography.md

Use the .bibliography function to include a bibliography file in your document.

```markdown
.bibliography {bibliography/file.bib}
```

--------------------------------

### Create a new project with the CLI

Source: https://quarkdown.com/wiki/quickstart.md

Run this command in your terminal to initialize a new project folder. Omitting the name will use the current working directory.

```shell
quarkdown create my-document
```

--------------------------------

### Compile with --allow permissions

Source: https://quarkdown.com/wiki/cli-compiler.md

Compiles main.qd while granting the network and global-read permissions. The final permission set is computed as defaults + allowed - denied.

```shell
quarkdown c main.qd --allow network --allow global-read
```

--------------------------------

### Chaining with additional arguments example

Source: https://quarkdown.com/wiki/syntax-of-a-function-call.md

Shows appending an additional argument to a function in a chain. The chained value is always the first argument of the next call. The output of this example is 30.

```markdown
.sum {10} {5}::multiply {2}
```

--------------------------------

### Create theorem and proof blocks

Source: https://quarkdown.com/wiki/paper-library.md

Use .theorem and .proof to structure mathematical content with an end-of-proof character.

```markdown
.theorem
    .loremipsum

.proof
    .loremipsum
```

--------------------------------

### Inline function call example (Example 9)

Source: https://quarkdown.com/wiki/syntax-of-a-function-call.md

Demonstrates an inline function call embedded within text. The call '.sum {26} {16}' is replaced by its output (42) in the parent block.

```markdown
Ever wondered what **26+16** equals? It's .sum {26} {16}. Here you go.
```

--------------------------------

### Create a definition block

Source: https://quarkdown.com/wiki/paper-library.md

Use the .definition command to create a titled definition block.

```markdown
.definition
    Let $ \Delta x $ be an object's change in position over a time interval $ \Delta t $,
    then the average velocity is defined as $ v = \frac {\Delta x} {\Delta t} $.
```

--------------------------------

### Bulk include files

Source: https://quarkdown.com/wiki/listing-files.md

Composes .listfiles with .includeall to load multiple files.

```markdown
.listfiles {chapters} sortby:{name}::includeall
```

--------------------------------

### Define a size group

Source: https://quarkdown.com/wiki/sizes.md

Example of using a vertical/horizontal size group for padding.

```markdown
.container padding:{10px 60px} background:{teal}
    Quarkdown
```

--------------------------------

### Include multiple files with .includeall

Source: https://quarkdown.com/wiki/quickstart.md

Use .includeall to include a list of files for larger projects.

```markdown
.includeall
    - setup.qd
    - content.qd
```

--------------------------------

### Define a single size

Source: https://quarkdown.com/wiki/sizes.md

Example of using single size values with units in a container definition.

```markdown
.container width:{50px} height:{2cm} background:{teal}
```

--------------------------------

### Configure Bibliography Style

Source: https://quarkdown.com/wiki/bibliography.md

Example of applying the APA citation style to a bibliography block in Markdown.

```markdown
.bibliography {bibliography.bib} style:{apa}
```

--------------------------------

### Emoji Shortcode Variants

Source: https://quarkdown.com/wiki/emojis.md

Examples of using shortcodes for simple emojis and those with skin tone modifiers.

```text
.emoji {wink}
```

```text
.emoji {waving-hand~medium-dark}
```

```text
.emoji {people-holding-hands~medium-light,medium-dark}
```

--------------------------------

### Emulating else with .let

Source: https://quarkdown.com/wiki/conditional-statements.md

Demonstrates how to emulate an else statement by storing a condition in a variable using .let and checking it with .if and .ifnot.

```markdown
.let {.iseven {3}}
    condition:
    .if {.condition}
        3 is even!
    .ifnot {.condition}
        3 is odd!
```

--------------------------------

### Create a box with a title

Source: https://quarkdown.com/wiki/box.md

Demonstrates the basic syntax for creating a box container with a specified title.

```markdown
.box {Box title}
    Welcome to the **Quarkdown wiki**!
    Here you'll learn how to get started with your first document.
```

--------------------------------

### Bulk include with directory listing

Source: https://quarkdown.com/wiki/including-other-quarkdown-files.md

Combines .includeall with .listfiles to automatically include all files in a directory.

```markdown
.includeall {.listfiles {somedirectory} sortby:{name}}
```

--------------------------------

### Basic .if usage

Source: https://quarkdown.com/wiki/conditional-statements.md

Demonstrates the basic syntax of the .if function, which executes the provided lambda only if the condition is true.

```markdown
.if {yes}
    Hello, Quarkdown!
```

--------------------------------

### Row with images

Source: https://quarkdown.com/wiki/stacks.md

Example 3: A .row stack containing two image blocks, each on its own line with a blank line between them.

```markdown
.row
    ![](assets/icon.svg)

    ![](assets/icon.svg)

```

--------------------------------

### Locate SKILL.md for ChatGPT and other agents

Source: https://quarkdown.com/wiki/agent-skill.md

Run this command to output the file path for SKILL.md, which can then be uploaded or pointed to by your agent.

```shell
echo "$(quarkdown doctor get agent-skill)/SKILL.md"
```

--------------------------------

### Configure page format and margins

Source: https://quarkdown.com/wiki/quickstart.md

Set the page size and margins using the .pageformat function.

```markdown
.pageformat {letter} margin:{2cm}
```

--------------------------------

### Function call syntax with positional and named arguments

Source: https://quarkdown.com/wiki/quickstart.md

Demonstrates the basic syntax for function calls using a dot prefix and curly braces for arguments.

```markdown
.pow {5} to:{2} is a mathematical operation.
```

--------------------------------

### Basic usage of .heading

Source: https://quarkdown.com/wiki/headings.md

Creates a level 2 heading equivalent to standard Markdown ## syntax.

```markdown
.heading {My heading} depth:{2}
```

--------------------------------

### Basic image size syntax with pixel units

Source: https://quarkdown.com/wiki/image-size.md

Loads image.png with label 'Alt' and constrains it to 300px by 100px. The delimiter can be 'x', '*', or a space.

```markdown
!(300x100)[Alt](image.png)

<!-- or -->

!(300*100)[Alt](image.png)

<!-- or -->

!(300 100)[Alt](image.png)
```

--------------------------------

### Create an initially open collapsible block with .collapse open:{yes}

Source: https://quarkdown.com/wiki/collapsible.md

Creates a collapsible block that is initially expanded by passing `open:{yes}`. The `open` argument defaults to `false` (collapsed).

```markdown
.collapse {A _collapsible_ block. **Click me!**} open:{yes}
    Not so hidden content anymore!
```

--------------------------------

### Clip general content to a circle

Source: https://quarkdown.com/wiki/clip.md

Clipping works with any content, not just images. This example clips a container with padding and background color.

```markdown
.clip {circle}
    .container padding:{2cm} background:{teal}
        #! Hello!
```

--------------------------------

### Add an icon to external links

Source: https://quarkdown.com/wiki/quickstart.md

Intercept the .link primitive function to append an icon to links that do not start with the specified URL.

```markdown
.extend {link} where:{url: .url::startswith {https://quarkdown.com}::not}
    content:
    .super
        .content .icon {box-arrow-up-right}
```

--------------------------------

### Retrieve a column with .tablecolumn

Source: https://quarkdown.com/wiki/table-manipulation.md

Extracts the second column as an Iterable and stores it in a variable, then gets the first element. The output is 25.

```markdown
.var {values}
    .tablecolumn {2}
        | Name | Age | City |
        |------|-----|------|
        | John | 25  | NY   |
        | Lisa | 32  | LA   |
        | Mike | 19  | CHI  |

.values::first
```

--------------------------------

### Declare function with parameters and invoke with positional arguments

Source: https://quarkdown.com/wiki/declaring-functions.md

Declares a function 'greet' with two parameters 'to' and 'from'. Invokes it with positional arguments, producing 'Hello, world from John!'.

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

.greet {world} {John}
```
Tokens:
Raw