Cheatsheets:Quarto - Revision history

SeedBot: Standardize: add copy button to block code snippets

2026-08-23T09:45:57Z

Standardize: add copy button to block code snippets

Rongzhou at 08:08, 23 August 2026

2026-08-23T08:08:04Z

← Older revision		Revision as of 08:08, 23 August 2026
Line 1:		Line 1:
	{{Cheatsheet}}		{{Cheatsheet}}


			Quarto is like modern Latex+Jupyter: a scientific and technical publishing system that converts Markdown text, YAML front matter, and executable code chunks into publishing-grade HTML, PDF, Word and
			more.

	<blockquote>		<blockquote>
	~~Quarto is a scientific and technical publishing system: Markdown content, YAML~~		'''Quarto uses Markdown for prose content. If you are unfamiliar with Markdown syntax, see [[Cheatsheets:Markdown]].
	~~front matter and executable code chunks that render to HTML, PDF, Word and~~		</blockquote>
	~~more. It builds on Pandoc.~~

	'''Quarto uses Markdown for prose content. If you are unfamiliar with Markdown syntax, see [[Cheatsheets:~~markdown~~]].

	New to Quarto? You may find this		New to Quarto? You may find this
	[https://quarto.org/docs/get-started/hello/ Get Started tutorial] interesting.		[https://quarto.org/docs/get-started/hello/ Get Started tutorial] interesting.
	~~</blockquote>~~

	== Basic example: Pancake recipe ==		== Basic example: Pancake recipe ==

Rongzhou: /* Front matter */

2026-08-20T10:25:01Z

Front matter

← Older revision		Revision as of 10:25, 20 August 2026
Line 93:		Line 93:
	\|}		\|}

	~~The~~ <syntaxhighlight lang="yaml" inline>format</syntaxhighlight> ~~key picks the output. HTML and PDF work out of the box~~:		Available <syntaxhighlight lang="yaml" inline>format</syntaxhighlight>:

	{\| class="wikitable"		{\| class="wikitable"
Line 110:		Line 110:
	\| <syntaxhighlight lang="yaml" inline>gfm</syntaxhighlight> \|\| GitHub Flavored Markdown		\| <syntaxhighlight lang="yaml" inline>gfm</syntaxhighlight> \|\| GitHub Flavored Markdown
	\|}		\|}

			HTML and PDF work out of the box. Others may require additional setup.

	<blockquote>		<blockquote>

SeedBot: Per style guide: formats note as blockquote with wrong/right pair, eval/include/echo as source/rendered tables, cross-references show all three targets, Formats table moved into Front matter, Projects annotated (via update-page on MediaWiki MCP Server)

2026-08-19T21:04:39Z

Per style guide: formats note as blockquote with wrong/right pair, eval/include/echo as source/rendered tables, cross-references show all three targets, Formats table moved into Front matter, Projects annotated (via update-page on MediaWiki MCP Server)

Show changes

Rongzhou: /* Code chunks */

2026-08-19T19:50:24Z

Code chunks

← Older revision		Revision as of 19:50, 19 August 2026
Line 125:		Line 125:
	== Code chunks ==		== Code chunks ==

	A fenced ~~block whose info string names a~~ language '''in braces''' ~~runs as code;~~ the engine ~~executes it and inserts the~~ output:		* A fenced Markdown codeblock
			* language name must be wrapped '''in <code>{</code> braces'''
			* executed by the compile engine
			* output inserted into rendered document

	<syntaxhighlight lang="markdown">		<syntaxhighlight lang="markdown">
Line 133:		Line 136:
	</syntaxhighlight>		</syntaxhighlight>

	~~Engines include~~ python (via Jupyter), r (via knitr), julia, bash and ojs.		Available languages: python (via Jupyter), r (via knitr), julia, bash, and ojs.

	=== Chunk options ===		=== Chunk options ===

	Lines starting with <syntaxhighlight lang="yaml" inline>#\|</syntaxhighlight> at the top of the chunk ~~configure it~~:		Lines starting with <syntaxhighlight lang="yaml" inline>#\|</syntaxhighlight> at the top of the chunk modifies compile-time behaviour:

	{\| class="wikitable"		{\| class="wikitable"

Rongzhou: /* Front matter */

2026-08-19T19:22:16Z

Front matter

← Older revision		Revision as of 19:22, 19 August 2026
Line 63:		Line 63:
	== Front matter ==		== Front matter ==

	YAML between <syntaxhighlight lang="text" inline>---</syntaxhighlight> lines at the top of the file:		* YAML
			* wrapped between two <syntaxhighlight lang="text" inline>---</syntaxhighlight> lines
			* always at the top of the file

	<syntaxhighlight lang="yaml">		<syntaxhighlight lang="yaml">
Line 100:		Line 102:

	<blockquote>		<blockquote>
	'''A colon in an unquoted value ~~must be quoted~~''' ~~— it ends the mapping, and the render fails:~~		'''A colon in an unquoted value causes a fatal exception:'''

	{\| class="wikitable"		{\| class="wikitable"

Rongzhou: /* Basic example: Pancake recipe */

2026-08-19T19:17:42Z

Basic example: Pancake recipe

← Older revision		Revision as of 19:17, 19 August 2026
Line 14:		Line 14:
	== Basic example: Pancake recipe ==		== Basic example: Pancake recipe ==

	A <syntaxhighlight lang="text" inline>.qmd</syntaxhighlight> file: YAML front matter ~~between <syntaxhighlight lang="text" inline>---</syntaxhighlight> lines, then~~ Markdown ~~with a Python chunk. Render it with <syntaxhighlight lang="bash" inline>quarto render pancake.qmd</syntaxhighlight>:~~		A <syntaxhighlight lang="text" inline>.qmd</syntaxhighlight> file =

			# YAML front matter +
			# Markdown prose +
			# Code chunks (usually python)

	{\| class="wikitable"		{\| class="wikitable"
	! Source (.qmd) !! Rendered (html)		! Source (.qmd) !! Rendered with <syntaxhighlight lang="bash" inline>quarto render pancake.qmd</syntaxhighlight> into html
	\|-		\|-
	\|		\|
	<syntaxhighlight lang="markdown">		<syntaxhighlight lang="markdown" line>
	---		---
	title: "Pancake quantities"		title: "Pancake quantities"
Line 55:		Line 59:
	\|}		\|}

	~~The chunk runs~~ at render time. ~~With~~ <syntaxhighlight lang="yaml" inline>echo: false</syntaxhighlight> the source ~~stays hidden;~~ only the output appears in the document.		By default, the code chunks run at render time. <syntaxhighlight lang="yaml" inline>echo: false</syntaxhighlight> (14) in the example hides the source code, so only the output appears in the rendered document here.

	== Front matter ==		== Front matter ==

SeedBot: Rewrite per style guide: source/rendered side-by-side basic example, fix multi-format syntax (map, not list), move notes into their sections, add document-wide execute options and Projects section (via update-page on MediaWiki MCP Server)

2026-08-19T18:53:37Z

Rewrite per style guide: source/rendered side-by-side basic example, fix multi-format syntax (map, not list), move notes into their sections, add document-wide execute options and Projects section (via update-page on MediaWiki MCP Server)

Show changes

Rongzhou at 18:20, 19 August 2026

2026-08-19T18:20:54Z

← Older revision		Revision as of 18:20, 19 August 2026
Line 6:		Line 6:
	more. It builds on Pandoc.		more. It builds on Pandoc.

	'''Markdown syntax ~~is not repeated here''' — every construct on~~		'''Quarto uses Markdown for prose content. If you are unfamiliar with Markdown syntax, see [[Cheatsheets:markdown]].
	[[Cheatsheets:markdown]] ~~works identically inside a Quarto document. This page~~
	~~covers what Quarto adds: front matter, code chunks, cross-references, formats~~
	~~and the command line~~.

	New to Quarto? ~~Follow the~~		New to Quarto? You may find this
	[https://quarto.org/docs/get-started/hello/ Get Started tutorial]		[https://quarto.org/docs/get-started/hello/ Get Started tutorial] interesting.
	~~first, then come back to look things up.~~

	~~The running example is the same pancake recipe as on the Markdown page, with~~
	~~the batter volume computed in code~~.
	</blockquote>		</blockquote>

SeedBot: Create Quarto cheatsheet pointing to Cheatsheets:markdown for markdown syntax (via create-page on MediaWiki MCP Server)

2026-08-19T14:43:07Z

Create Quarto cheatsheet pointing to Cheatsheets:markdown for markdown syntax (via create-page on MediaWiki MCP Server)

New page

{{Cheatsheet}}

<blockquote>
Quarto is a scientific and technical publishing system: Markdown content, YAML
front matter and executable code chunks that render to HTML, PDF, Word and
more. It builds on Pandoc.

'''Markdown syntax is not repeated here''' — every construct on
[[Cheatsheets:markdown]] works identically inside a Quarto document. This page
covers what Quarto adds: front matter, code chunks, cross-references, formats
and the command line.

New to Quarto? Follow the
[https://quarto.org/docs/get-started/hello/ Get Started tutorial]
first, then come back to look things up.

The running example is the same pancake recipe as on the Markdown page, with
the batter volume computed in code.
</blockquote>

== Basic example ==

A <syntaxhighlight lang="text" inline>.qmd</syntaxhighlight> file: front matter between <syntaxhighlight lang="text" inline>---</syntaxhighlight> lines, then Markdown with a Python chunk:

<syntaxhighlight lang="markdown">
---
title: "Pancake quantities"
format: html
---

## Ingredients

- 150 g flour
- 250 ml milk

## Batter volume

```{python}
# | echo: false
flour = 150
milk = 250
print(f"Batter volume: {flour + milk} ml")
```
</syntaxhighlight>

Render it:

<syntaxhighlight lang="bash">
quarto render pancake.qmd
</syntaxhighlight>

The chunk runs at render time; with <syntaxhighlight lang="yaml" inline>echo: false</syntaxhighlight> the source stays hidden and only the output appears in the document:

<blockquote>
'''Ingredients'''
* 150 g flour
* 250 ml milk

'''Batter volume'''
<syntaxhighlight lang="text">
Batter volume: 400 ml
</syntaxhighlight>
</blockquote>

== Front matter ==

YAML between <syntaxhighlight lang="text" inline>---</syntaxhighlight> lines at the top of the file:

<syntaxhighlight lang="yaml">
---
title: "Pancake quantities"
author: "Ada"
date: today
format: html
toc: true
---
</syntaxhighlight>

{| class="wikitable"
! Key !! Effect
|-
| <syntaxhighlight lang="yaml" inline>title: "Pancakes"</syntaxhighlight> || document title
|-
| <syntaxhighlight lang="yaml" inline>author: Ada</syntaxhighlight> || author; a list of authors: <syntaxhighlight lang="yaml" inline>[Ada, Bo]</syntaxhighlight>
|-
| <syntaxhighlight lang="yaml" inline>date: today</syntaxhighlight> || date; the magic value <syntaxhighlight lang="yaml" inline>today</syntaxhighlight> becomes the current date at render time
|-
| <syntaxhighlight lang="yaml" inline>format: html</syntaxhighlight> || output format; several at once: <syntaxhighlight lang="yaml" inline>[html, pdf]</syntaxhighlight>
|-
| <syntaxhighlight lang="yaml" inline>toc: true</syntaxhighlight> || table of contents
|-
| <syntaxhighlight lang="yaml" inline>lang: en</syntaxhighlight> || document language
|}

== Code chunks ==

A fenced block whose info string names a language '''in braces''' runs as code; the engine executes it and inserts the output:

<syntaxhighlight lang="markdown">
```{python}
print("hi")
```
</syntaxhighlight>

Engines include python (via Jupyter), r (via knitr), julia, bash and ojs.

'''Chunk options''' — lines starting with <syntaxhighlight lang="yaml" inline>#|</syntaxhighlight> at the top of the chunk configure it:

{| class="wikitable"
! Option !! Effect !! Example
|-
| <syntaxhighlight lang="yaml" inline>echo</syntaxhighlight> || show the source (default true) || <syntaxhighlight lang="yaml" inline>#| echo: false</syntaxhighlight>
|-
| <syntaxhighlight lang="yaml" inline>eval</syntaxhighlight> || run the code (default true) || <syntaxhighlight lang="yaml" inline>#| eval: false</syntaxhighlight>
|-
| <syntaxhighlight lang="yaml" inline>include</syntaxhighlight> || keep source and output in the document (default true) || <syntaxhighlight lang="yaml" inline>#| include: false</syntaxhighlight>
|-
| <syntaxhighlight lang="yaml" inline>label</syntaxhighlight> || chunk label, referenced with <syntaxhighlight lang="text" inline>@label</syntaxhighlight> || <syntaxhighlight lang="yaml" inline>#| label: fig-batter</syntaxhighlight>
|-
| <syntaxhighlight lang="yaml" inline>fig-cap</syntaxhighlight> || caption for figure output || <syntaxhighlight lang="yaml" inline>#| fig-cap: "Batter volume"</syntaxhighlight>
|}

'''echo''' — without it source and output both appear; with <syntaxhighlight lang="yaml" inline>echo: false</syntaxhighlight> only the output:

{| class="wikitable"
! Without (default) !! With echo: false
|-
|
<syntaxhighlight lang="python">
flour = 150
milk = 250
print(f"Batter volume: {flour + milk} ml")
</syntaxhighlight>

Output:
<syntaxhighlight lang="text">
Batter volume: 400 ml
</syntaxhighlight>
||
<syntaxhighlight lang="python">
# | echo: false
flour = 150
milk = 250
print(f"Batter volume: {flour + milk} ml")
</syntaxhighlight>

Output:
<syntaxhighlight lang="text">
Batter volume: 400 ml
</syntaxhighlight>
|}

'''eval: false''' — the source is shown but nothing runs, handy for scratch code you want to keep visible.

== Inline code ==

Inline code executes when the language is named in braces:

{| class="wikitable"
! Source !! Renders as
|-
| <syntaxhighlight lang="markdown" inline>`{python} flour + milk`</syntaxhighlight> || 400
|-
| <syntaxhighlight lang="markdown" inline>`flour + milk`</syntaxhighlight> || flour + milk (literal, not evaluated)
|}

== Cross-references ==

Give a section, table or figure an identifier, then refer to it with <syntaxhighlight lang="text" inline>@</syntaxhighlight>:

<syntaxhighlight lang="markdown">
## Recipe data {#sec-data}

The amounts live in @sec-data; see Table @tbl-pan.

| Ingredient | Amount |
|---|---|
| Flour | 150 g |

: Pancake ingredients {#tbl-pan}
</syntaxhighlight>

The reference <syntaxhighlight lang="text" inline>@sec-data</syntaxhighlight> renders as "Section 1", the
table caption becomes "Table 1: Pancake ingredients", and figures are
referenced the same way with <syntaxhighlight lang="text" inline>@fig-label</syntaxhighlight>.

== Formats ==

The <syntaxhighlight lang="yaml" inline>format</syntaxhighlight> key picks the output. HTML and PDF work out of the box:

{| class="wikitable"
! format !! output
|-
| <syntaxhighlight lang="yaml" inline>html</syntaxhighlight> || standalone HTML page
|-
| <syntaxhighlight lang="yaml" inline>pdf</syntaxhighlight> || PDF, via LaTeX or the Typst engine
|-
| <syntaxhighlight lang="yaml" inline>typst</syntaxhighlight> || PDF via the Typst engine bundled with Quarto
|-
| <syntaxhighlight lang="yaml" inline>docx</syntaxhighlight> || Word document
|-
| <syntaxhighlight lang="yaml" inline>revealjs</syntaxhighlight> || HTML slide deck
|-
| <syntaxhighlight lang="yaml" inline>gfm</syntaxhighlight> || GitHub Flavored Markdown
|}

== CLI ==

{| class="wikitable"
! Command !! What it does
|-
| <syntaxhighlight lang="bash" inline>quarto render file.qmd</syntaxhighlight> || render one file, or a whole project
|-
| <syntaxhighlight lang="bash" inline>quarto render file.qmd --to pdf</syntaxhighlight> || override the output format
|-
| <syntaxhighlight lang="bash" inline>quarto preview</syntaxhighlight> || live-render preview while editing
|-
| <syntaxhighlight lang="bash" inline>quarto create-project --type website</syntaxhighlight> || scaffold a project (default, book, website, manuscript)
|-
| <syntaxhighlight lang="bash" inline>quarto publish gh-pages</syntaxhighlight> || publish to GitHub Pages, Netlify or Quarto Pub
|}

<blockquote>
'''Gotcha:''' a fence without braces is a static code block — it never runs. A
chunk that "does nothing" is usually this:

<syntaxhighlight lang="markdown">
```python
print("hi")
```
</syntaxhighlight>

Fix: put the language in braces, then it executes:

<syntaxhighlight lang="markdown">
```{python}
print("hi")
```
</syntaxhighlight>

The inline form follows the same rule: <syntaxhighlight lang="markdown" inline>`{python} flour + milk`</syntaxhighlight> renders as 400, while <syntaxhighlight lang="markdown" inline>`flour + milk`</syntaxhighlight> renders the literal text flour + milk.
</blockquote>

<blockquote>
'''Gotcha:''' YAML values containing a colon must be quoted. Unquoted:

<syntaxhighlight lang="yaml">
title: Pancakes: the recipe
</syntaxhighlight>

fails at render time with
<syntaxhighlight lang="text">
ERROR: YAMLException: bad indentation of a mapping entry
</syntaxhighlight>

Fix: quote the value:

<syntaxhighlight lang="yaml">
title: "Pancakes: the recipe"
</syntaxhighlight>
</blockquote>

== Further reading ==

* [https://quarto.org/docs/ Quarto documentation] — the official docs
* [https://quarto.org/docs/get-started/hello/ Get Started tutorial] — the recommended tutorial
* [[Cheatsheets:markdown]] — Markdown syntax used by Quarto
* [https://pandoc.org/ Pandoc] — the document converter Quarto builds on