quarto-authoring

Category: Testing & Security | Uploader: mlr-org | Downloads: 0 | Version: v1.0（Latest）

Comprehensive guidance for Quarto document authoring and R Markdown migration.

Changelog: Source: GitHub https://github.com/mlr-org/actions

Directory Structure

Current level: skills/authoring/

📁 references/
- 📄 callouts.md 5.3 KB
- 📄 citations.md 5.7 KB
- 📄 code-cells.md 7.8 KB
- 📄 conditional-content.md 6.1 KB
- 📄 conversion-blogdown.md 8.1 KB
- 📄 conversion-bookdown.md 6.0 KB
- 📄 conversion-distill.md 6.7 KB
- 📄 conversion-rmarkdown.md 6.4 KB
- 📄 conversion-xaringan.md 6.4 KB
- 📄 cross-references.md 6.1 KB
- 📄 diagrams.md 6.8 KB
- 📄 divs-and-spans.md 5.3 KB
- 📄 extensions.md 5.5 KB
- 📄 figures.md 5.3 KB
- 📄 layout.md 6.5 KB
- 📄 markdown-linting.md 6.0 KB
- 📄 shortcodes.md 5.2 KB
- 📄 tables.md 7.8 KB
- 📄 yaml-front-matter.md 6.7 KB
📄 SKILL.md 9.0 KB

SKILL.md

---
name: quarto-authoring
description: >
  Comprehensive guidance for Quarto document authoring and R Markdown migration.
  Use this skill when: (1) Writing new Quarto documents (.qmd) with best practices,
  (2) Converting R Markdown (.Rmd) documents to Quarto, (3) Migrating bookdown,
  blogdown, xaringan, or distill projects to Quarto, (4) Understanding Quarto's
  code cell syntax with hashpipe (#|) options, (5) Setting up cross-references
  for figures, tables, sections, and equations, (6) Using Quarto-specific markdown
  features like callouts, divs, and spans, (7) Configuring YAML front matter for
  documents and projects, (8) Finding and using Quarto extensions.
---

# Quarto Authoring

> This skill is based on Quarto CLI v1.8.26.

## When to Use What

Task: Write a new Quarto document
Use: Follow "QMD Essentials" below, then see specific reference files

Task: Convert R Markdown to Quarto
Use: [references/conversion-rmarkdown.md](references/conversion-rmarkdown.md)

Task: Migrate bookdown project
Use: [references/conversion-bookdown.md](references/conversion-bookdown.md)

Task: Migrate xaringan slides
Use: [references/conversion-xaringan.md](references/conversion-xaringan.md)

Task: Migrate distill article
Use: [references/conversion-distill.md](references/conversion-distill.md)

Task: Migrate blogdown site
Use: [references/conversion-blogdown.md](references/conversion-blogdown.md)

Task: Add cross-references
Use: [references/cross-references.md](references/cross-references.md)

Task: Configure code cells
Use: [references/code-cells.md](references/code-cells.md)

Task: Add figures with captions
Use: [references/figures.md](references/figures.md)

Task: Create tables
Use: [references/tables.md](references/tables.md)

Task: Add citations and bibliography
Use: [references/citations.md](references/citations.md)

Task: Add callout blocks
Use: [references/callouts.md](references/callouts.md)

Task: Add diagrams (Mermaid, Graphviz)
Use: [references/diagrams.md](references/diagrams.md)

Task: Control page layout
Use: [references/layout.md](references/layout.md)

Task: Use shortcodes
Use: [references/shortcodes.md](references/shortcodes.md)

Task: Add conditional content
Use: [references/conditional-content.md](references/conditional-content.md)

Task: Use divs and spans
Use: [references/divs-and-spans.md](references/divs-and-spans.md)

Task: Configure YAML front matter
Use: [references/yaml-front-matter.md](references/yaml-front-matter.md)

Task: Find and use extensions
Use: [references/extensions.md](references/extensions.md)

Task: Apply markdown linting rules
Use: [references/markdown-linting.md](references/markdown-linting.md)

## QMD Essentials

### Basic Document Structure

```markdown
---
title: "Document Title"
author: "Author Name"
date: today
format: html
---

Content goes here.
```

A Quarto document consists of two main parts:

1. **YAML Front Matter**: Metadata and configuration at the top, enclosed by `---`.
2. **Markdown Content**: Main body using standard markdown syntax.

### Divs and Spans

Divs use fenced syntax with three colons:

```markdown
::: {.class-name}
Content inside the div.
:::
```

Spans use bracketed syntax:

```markdown
This is [important text]{.highlight}.
```

Details: [references/divs-and-spans.md](references/divs-and-spans.md)

### Code Cell Options Syntax

A code cell starts with triple backticks and a language identifier between curly braces.
Code cells are code blocks that can be executed to produce output.

Quarto uses the language's comment symbol + `|` for cell options. Options use **dashes, not dots** (e.g., `fig-cap` not `fig.cap`).

- R, Python: `#|`
- Mermaid: `%%|`
- Graphviz/DOT: `//|`

````markdown
```{r}
#| label: fig-example
#| echo: false
#| fig-cap: "A scatter plot example."
#| fig-width: 8
#| fig-height: 6

plot(x, y)
```
````

Common execution options:

| Option    | Description       | Values                    |
| --------- | ----------------- | ------------------------- |
| `eval`    | Evaluate code     | `true`, `false`           |
| `echo`    | Show code         | `true`, `false`, `fenced` |
| `output`  | Include output    | `true`, `false`, `asis`   |
| `warning` | Show warnings     | `true`, `false`           |
| `error`   | Show errors       | `true`, `false`           |
| `include` | Include in output | `true`, `false`           |

Set document-level defaults in YAML front matter:

```yaml
execute:
  echo: false
  warning: false
```

Details: [references/code-cells.md](references/code-cells.md)

### Cross-References

Labels must start with a type prefix. Reference with `@`:

- Figure: `fig-` prefix, e.g., `#| label: fig-plot` → `@fig-plot`
- Table: `tbl-` prefix, e.g., `#| label: tbl-data` → `@tbl-data`
- Section: `sec-` prefix, e.g., `{#sec-intro}` → `@sec-intro`
- Equation: `eq-` prefix, e.g., `{#eq-model}` → `@eq-model`

Example:

```markdown
::: {#fig-plot}
A plot.

A caption for the plot.
:::

See @fig-plot for the results.
```

````markdown
```{r}
#| label: fig-plot
#| fig-cap: "A caption for the plot."
plot(1)
```

See @fig-plot for the results.
````

Details: [references/cross-references.md](references/cross-references.md)

### Callout Blocks

Five types: `note`, `warning`, `important`, `tip`, `caution`.

```markdown
::: {.callout-note}
This is a note callout.
:::

::: {.callout-warning}

## Custom Title

This is a warning with a custom title.

:::
```

Details: [references/callouts.md](references/callouts.md)

### Figures

Basic figure with caption:

```markdown
![Caption text](image.png){#fig-name fig-alt="Alt text"}
```

Subfigures:

```markdown
::: {#fig-group layout-ncol=2}
![Sub caption 1](image1.png){#fig-sub1}

![Sub caption 2](image2.png){#fig-sub2}

Main caption for the group.
:::
```

Details: [references/figures.md](references/figures.md)

### Tables

Pipe table with caption:

```markdown
::: {#tbl-example}

| Column 1 | Column 2 |
| -------- | -------- |
| Data 1   | Data 2   |

Table caption.
:::
```

Details: [references/tables.md](references/tables.md)

### Citations

Basic syntax:

```markdown
According to @smith2020, the results show...
Multiple citations [@smith2020; @jones2021].
Parenthetical only [-@smith2020].
```

Configure in YAML:

```yaml
bibliography: references.bib
csl: apa.csl
```

Details: [references/citations.md](references/citations.md)

## Common Workflows

### Creating an HTML Document

```yaml
title: "My Report"
author: "Your Name"
date: today
format:
  html:
    toc: true
    code-fold: true
    theme: cosmo
```

### Creating a PDF Document

```yaml
title: "My Report"
format:
  pdf:
    documentclass: article
    papersize: a4
```

### Creating a RevealJS Presentation

```markdown
---
title: "My Presentation"
format: revealjs
---

## First Slide

Content here.

## Second Slide

More content.
```

### Setting Up a Quarto Project

Create `_quarto.yml` in the project root:

```yaml
project:
  type: website

website:
  title: "My Site"
  navbar:
    left:
      - href: index.qmd
        text: Home
      - href: about.qmd
        text: About

format:
  html:
    theme: cosmo
```

## Resources

### Reference Files

- [references/code-cells.md](references/code-cells.md) - Hashpipe syntax, execution options, code display
- [references/cross-references.md](references/cross-references.md) - Labels, prefixes, all reference types
- [references/figures.md](references/figures.md) - Figures, subfigures, layouts, lightbox
- [references/tables.md](references/tables.md) - Pipe tables, grid tables, styling
- [references/citations.md](references/citations.md) - Bibliography, CSL, footnotes
- [references/callouts.md](references/callouts.md) - Callout types, appearance, collapsible
- [references/diagrams.md](references/diagrams.md) - Mermaid, Graphviz/DOT
- [references/layout.md](references/layout.md) - Column classes, margin content
- [references/shortcodes.md](references/shortcodes.md) - Built-in shortcodes
- [references/conditional-content.md](references/conditional-content.md) - Format-specific content
- [references/divs-and-spans.md](references/divs-and-spans.md) - Fenced divs, spans, raw blocks
- [references/yaml-front-matter.md](references/yaml-front-matter.md) - Document and project YAML
- [references/extensions.md](references/extensions.md) - Using and finding extensions
- [references/markdown-linting.md](references/markdown-linting.md) - Markdown linting rules for Quarto

### Conversion Guides

- [references/conversion-rmarkdown.md](references/conversion-rmarkdown.md) - R Markdown to Quarto
- [references/conversion-bookdown.md](references/conversion-bookdown.md) - bookdown to Quarto
- [references/conversion-xaringan.md](references/conversion-xaringan.md) - xaringan to RevealJS
- [references/conversion-distill.md](references/conversion-distill.md) - distill to Quarto
- [references/conversion-blogdown.md](references/conversion-blogdown.md) - blogdown to Quarto website

### External Resources

- [Quarto Documentation](https://quarto.org/docs/)
- [Quarto Guide](https://quarto.org/docs/guide/)
- [Quarto Extensions](https://quarto.org/docs/extensions/)
- [Community Extensions List](https://m.canouil.dev/quarto-extensions/)

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

quarto-authoring

Directory Structure

SKILL.md

Report

Notice