Package-level declarations

Bibliography styles supported by bibliography. See here for examples of each style.

Exporter of Quarkdown's standard library.

The sorting order for a table column.

Bibliography stdlib module exporter. This module handles bibliographies and citations.

Collection stdlib module exporter. This module handles iterable collections.

Data stdlib module exporter. This module handles content fetched from external resources.

Dictionary stdlib module exporter. This module handles map-like dictionaries.

Document stdlib module exporter. This module handles document information and details.

Ecosystem stdlib module exporter. This module handles interaction between Quarkdown sources.

Flow stdlib module exporter. This module handles the control flow and other statements.

Injection stdlib module exporter. This module handles code injection of different languages.

Layout stdlib module exporter. This module handles position and shape of an element.

Library stdlib module exporter. This module handles loaded libraries and their functions.

Localization stdlib module exporter. This module handles localization-related features.

Logger stdlib module exporter. This module contains logging utility.

Logical stdlib module exporter.

Math stdlib module exporter.

Mermaid stdlib module exporter. This module handles generation of Mermaid diagrams.

Fallback value for non-existent elements in collections, dictionaries, and more.

Optionality stdlib module exporter. This module handles None values to express optional values.

Reference stdlib module exporter. This module handles cross-references.

Slides stdlib module exporter. This module handles slides properties.

String stdlib module exporter. This module handles string manipulation.

TableComputation stdlib module exporter. This module provides advanced functionality for tables, enhancing their capabilities beyond basic data representation. It adds dynamic operations like sorting, filtering, calculations.

Text stdlib module exporter. This module handles text formatting.

Aligns content and text within its parent.

Sets a new automatic page break threshold when a heading is found: if a heading's depth value (the amount of leading #s) is equal to or less than maxdepth, a page break is forced before the heading.

Generates a bibliography from a BibTeX file.

Inserts content in a styled box.

Creates a line break. In standard Markdown, this is also achievable with two spaces at the end of a line, but this function provides a more explicit and unambiguous way to insert a line break.

Capitalizes the first character of a string.

Sets the position of captions, relative to the content they describe.

Centers content and text within its parent.

Creates a citation to a bibliography entry.

Applies a clipping path to its content.

Creates a code block. Contrary to its standard Markdown implementation with backtick/tilde fences, this function accepts function calls within its code argument, hence it can be used - for example - in combination with read to load code from file.

Inserts content in a collapsible block, whose content can be hidden or shown by interacting with it.

Stacks content vertically.

Concatenates two strings if a condition is met.

A general-purpose container that groups content.

Creates a <style> HTML element with the provided CSS content. The content is wrapped in a <style> tag and rendered as-is, without any additional processing or escaping, as long as the rendering target supports HTML.

Overrides the value of Quarkdown CSS properties.

Loads a CSV file and returns its content as a display-ready table.

Displays the index (starting from 1) of the page this element lies in.

Logs a message (debug level) to the standard output. Note that -Dloglevel=debug must be enabled to see debug messages.

Makes the initialization of a dictionary explicit, to avoid ambiguity with collection initialization.

If author is specified, sets the document author to that value. This is a shortcut for docauthors when there's only one author without additional information.

If authors is specified, sets the document authors to that value. Compared to docauthor, this function allows for multiple authors and additional information.

If locale is specified, sets the document language to that value. The document language affects localization (localization, localize), hyphenation and other locale-specific properties.

If name is specified, sets the document name to that value. The document name affects the name of the output file.

If type is specified, sets the document type to that value. The document type affects its final output style, numbering format and several other properties.

Compares two values for equality.

Throws an Exception with the given message. The result depends on the pipeline's error handler. By default, the message is logged (error level) to the standard output and an error box is rendered on the document. If the program is run on strict mode, the stack trace is printed and the process will be stopped.

Inserts content in a figure block, which features an optional caption and can be numbered according to the figures numbering rules.

Turns content into a floating element, allowing subsequent content to wrap around it.

Updates the global font configuration of the document.

Displays content on the bottom center of each page of a document.

Repeats content for each element of an iterable collection. The current element can be accessed via the lambda argument, which may be either explicit or implicit.

Creates an element that, when used in a slides document, shows its content when the user attempts to go to the next slide.

If the document has a multi-column layout (set via pageformat), makes content span across all columns in a multi-column layout.

Defines a custom function that can be called later in the document.

Checks whether a function with the given name is registered in context.

Gets a value from a dictionary by its key.

Stacks content in a grid layout.

Groups a collection by their value.

Creates an HTML element, which is rendered as-is without any additional processing or escaping, as long as the rendering target supports HTML.

Performs a conditional evaluation of content, including the evaluation of body only if the condition is met. The expression is not evaluated if the condition is false.

Shorthand for .if {.condition::not}.

Maps value to the result of mapping.

This function has two behaviors:

Performs a bulk include of the given paths via include.

Checks if a string is empty.

Checks whether value represents a none value.

Checks if a string is not empty.

Transposes content to landscape orientation by rotating it 90 degrees counter-clockwise. This is useful for wide content, such as diagrams, that does not fit in the normal page orientation.

Defines a temporary variable that lives only inside the lambda body.

Checks whether a library with the given name is registered in context.

Lists the names of all functions exposed by the library with the given name.

Lists the names of all libraries loaded in context.

Defines and registers a new localization table, whose entries are key-value pairs for each locale and defined by a Markdown dictionary.

Localizes a key from a pre-existing localization table (defined via localization).

Logs a message (info level) to the standard output.

Converts a string to lowercase.

Creates an invisible marker, that points to a specific location in the document, and can be referenced by other elements as would happen with a regular heading.

Creates a Mermaid diagram.

Disables automatic page breaks when a heading is found.

Creates a null invisible node that forces the expression it lies in to be evaluated as Markdown content.

Disables numbering across the document, in case a default numbering is set by either numbering or the document type default.

Negates a boolean value.

Node that can be numbered depending on its location in the document and the amount of occurrences according to its key.

Sets the global numbering format across the document. Numbering is applied to elements that support it, such as headings and figures.

Returns value if it is not none, fallback otherwise.

Sets the page layout format of the document. If a value is unset, the default value supplied by the underlying renderer is used.

Displays content on each page of a document.

Creates a new pair.

Sets the global style of paragraphs in the document. If a value is unset, the default value supplied by the underlying renderer is used.

Creates a range of numbers, which can also be iterated through.

Creates a reference to a target node with a matching ID.

Repeats content N times. This is shorthand for .foreach {..N}.

Rounds a floating-point number to the nearest integer.

Stacks content horizontally.

Sets global properties that affect the behavior of a 'slides' document.

Creates a speaker note for a slides document.

Creates a string.

Displays a directed graph of subdocuments within the document.

Creates a table out of a collection of columns.

Retrieves a specific column from a table as a collection of values.

Retrieves all columns from a table as a collection of collections.

Performs a computation on a specific column of a table, appending the result to a new cell in the bottom.

Filters the rows of a table based on a boolean expression on a specific column.

Generates a table of contents, based on the headings in the document, organized in a hierarchical structure defined by each heading's depth.

Sorts a table based on the values of a column.

Keeps value if condition is true, otherwise returns none.

Creates a new global TeX macro that can be accessed within math blocks.

Creates an inline text node with specified formatting and transformation.

Inserts content in a collapsible text span, whose content can be expanded or collapsed by interacting with it.

Sets the document theme.

Creates a to do box, to mark content that needs to be done later, and also logs it to stdout.

Displays the total amount of pages in the document.

Truncates a floating-point number to a specified number of decimal places.

Converts a string to uppercase.

Defines a new variable or overwrites an existing one.

An empty rectangle that adds whitespace to the layout.

Creates a chart diagram on the XY plane.