Quarto

https://quarto.org/docs/
Admin
Quarto is an open-source scientific and technical publishing system that allows users to create...
Tokens:689,319
Snippets:6,200
Trust Score:10
Update:11 hours ago
Show doc for...
Tokens:
Raw
### Use a template extension with organization

Source: https://quarto.org/docs/extensions/formats.html

Example command to install a template extension from a GitHub organization, providing a working document out of the box.

```bash
quarto use template lexcorp/lexconf
```

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

### Choose tool to install with quarto install

Source: https://quarto.org/docs/cli/install.html

Runs quarto install without arguments to interactively choose which tool to install.

```bash
quarto install
```

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

### Install extension from a URL

Source: https://quarto.org/docs/cli/add.html

Installs an extension from a URL.

```bash
quarto add <url>
```

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

### Check installation and all engines

Source: https://quarto.org/docs/cli/check.html

Runs 'quarto check all' to verify the installation and all engines.

```bash
quarto check all
```

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

### Install packages from requirements.txt (Windows)

Source: https://quarto.org/docs/projects/virtual-environments.html

Installs all packages listed in requirements.txt on Windows.

```bash
py -m pip install -r requirements.txt
```

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

### Use a starter template with quarto use template

Source: https://quarto.org/docs/extensions/starter-templates.html

Instantiates a starter template from a GitHub repository. The command copies the repository contents to the local system, excluding hidden files, common GitHub files, and AI assistant config files. If run in a non-empty directory, the user is prompted for a new directory name.

```bash
quarto use template cooltools/cool-project
```

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

### Install rmarkdown package

Source: https://quarto.org/docs/interactive/shiny/

Install a recent version of the rmarkdown package to run the Shiny examples.

```r
 install.packages("rmarkdown")
```

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

### Install quarto-mode in Emacs

Source: https://quarto.org/docs/computations/r.html

Install the quarto-mode MELPA package using Emacs' package manager. After installation, use M-x quarto-preview to start a preview server.

```emacs-lisp
M-x package-refresh-contents
M-x package-install
  quarto-mode
```

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

### Preview example.qmd

Source: https://quarto.org/docs/extensions/brand.html

Run this command to preview the example.qmd file provided in the root of the brand extension. You should see a dark mode toggle in the upper right corner.

```bash
quarto preview example.qmd
```

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

### Example project directory structure

Source: https://quarto.org/docs/publishing/confluence.html

A sample project directory layout with _quarto.yml, index.qmd, team.qmd, and a projects folder containing planning.qmd and retrospectives.qmd.

```text
_quarto.yml
index.qmd
team.qmd
projects/
  planning.qmd
  retrospectives.qmd
```

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

### Install renv and initialize environment

Source: https://quarto.org/docs/projects/virtual-environments.html

Installs the renv package from CRAN and initializes a new renv environment. This modifies the .Rprofile file to automatically activate renv at the start of each R session.

```r
install.packages("renv")
renv::init()
```

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

### Example project structure with folders

Source: https://quarto.org/docs/publishing/confluence.html

An example project structure showing a top-level _quarto.yml, project-roadmap.qmd, team-members.qmd, and a reports-folder containing 2023-01.qmd and 2023-03.qmd.

```text
example-project/
├── _quarto.yml
├── project-roadmap.qmd
├── reports-folder
│   ├── 2023-01.qmd
│   └── 2023-03.qmd
└── team-members.qmd
```

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

### Configure project to use Binder

Source: https://quarto.org/docs/cli/use.html

Example of configuring the current project with Binder support.

```bash
quarto use binder
```

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

### Quarto YAML: include-in-header with text and file

Source: https://quarto.org/docs/output-formats/pdf-basics.html

Example YAML configuration for PDF format that includes raw LaTeX packages via text: and external files via file: or direct path. Packages not installed locally will be installed by Quarto during rendering.

```yaml
format:
  pdf:
    include-in-header:
      - text: |
          \usepackage{eplain}
          \usepackage{easy-todo}
      - file: packages.tex
      - macros.tex
```

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

### Required variables in _environment.required

Source: https://quarto.org/docs/projects/environment.html

Example of an `_environment.required` file that documents which environment variables must be defined to render the project. It can be copied to `_environment.local` as a starting point.

```plaintext
_environment.required

AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
```

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

### Render Project examples

Source: https://quarto.org/docs/cli/render.html

Examples of rendering a project, either the current directory or a specified project directory.

```bash
quarto render
quarto render projdir
```

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

### Access brand values via Lua API

Source: https://quarto.org/docs/authoring/brand.html

Use the 'brand' Lua module to access brand values in filters and shortcodes. This example gets the 'primary' color.

```lua
local brand = require('modules/brand/brand')
local primary = brand.get_color('primary')
```

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

### Render Notebook examples

Source: https://quarto.org/docs/cli/render.html

Examples of rendering a Jupyter notebook to DOCX, PDF with table of contents, and default output.

```bash
quarto render notebook.ipynb
quarto render notebook.ipynb --to docx
quarto render notebook.ipynb --to pdf --toc
```

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

### Publish the project with quarto publish confluence

Source: https://quarto.org/docs/publishing/confluence.html

Run quarto publish confluence from the project folder to publish the project to Confluence. You will be guided through account setup and destination selection.

```bash
quarto publish confluence
```

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

### Book project with custom preview server (serve)

Source: https://quarto.org/docs/reference/projects/books.html

Configures an external preview server for a book project using the `preview: serve` key. The command uses `{port}` and `{host}` placeholders, sets environment variables, and defines a ready regex. The `_quarto.yml` filename is shown above the code block.

```yaml
project:
  type: book
    preview:
      serve:
        cmd: "hugo serve --port {port} --bind {host} --navigateToChanged"
        env:
          HUGO_RELATIVEURLS: "true"
        ready: "Web Server is available at"
```

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

### Basic website configuration in _quarto.yml

Source: https://quarto.org/docs/reference/projects/websites.html

Example of setting website options under the `website` key in `_quarto.yml`. Includes `title`, `image`, and `page-navigation`.

```yaml
website:
  title: "My Website"
  image: opengraph.png
  page-navigation: true
```

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

### Video sources and options examples

Source: https://quarto.org/docs/authoring/videos.html

Shows multiple video source types (local file, YouTube, Vimeo) and options like width, height, title, start, and aspect-ratio.

```markdown
{{< video local-video.mp4 >}}

{{< video https://www.youtube.com/embed/wo9vZccmqwc >}}

{{< video https://vimeo.com/548291297 >}}

{{< video https://youtu.be/wo9vZccmqwc width="400" height="300" >}}

{{< video https://www.youtube.com/embed/wo9vZccmqwc
    title="What is the CERN?"
    start="116"
    aspect-ratio="21x9" 
>}}
```

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

### Create a diagram cross-reference with div syntax

Source: https://quarto.org/docs/authoring/cross-references-divs.html

Treat a diagram like a figure using a fenced div with an id starting with `fig-`. The example shows a simple graphviz graph.

```markdown
::: {#fig-simple}

```{dot}
graph {
  A -- B
}
```

This is a simple graphviz graph
:::

```

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

### Fully render all website/book formats then preview

Source: https://quarto.org/docs/cli/preview.html

Performs a full render of all formats before previewing.

```bash
quarto preview --render all
```

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

### List of files to be written

Source: https://quarto.org/docs/projects/binder.html

The output from `quarto use binder` showing the files that will be written: postBuild, apt.txt, and runtime.txt.

```text
The following files will be written:
┌─────────────┬────────────────────────────────────────┐
│ postBuild   │ Configures Quarto and supporting tools │
├─────────────┼────────────────────────────────────────┤
│ apt.txt     │ Installs Quarto required packages      │
├─────────────┼────────────────────────────────────────┤
│ runtime.txt │ Installs R and configures RStudio      │
└─────────────┴────────────────────────────────────────┘

 ? Continue? (Y/n) ›
```

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

### Use the ACM Journal Article template

Source: https://quarto.org/docs/extensions/starter-templates.html

Gets started with the ACM Journal Article extension using its starter template. This is an alternative to adding the format directly with quarto add.

```bash
quarto use template quarto-journals/acm
```

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

### Cross-referencing a callout with an ID

Source: https://quarto.org/docs/authoring/callouts.html

Add an ID starting with the appropriate prefix (e.g., #tip-) to a callout, then reference it using @ syntax. The example shows a tip callout with ID #tip-example and a reference to it.

```markdown
::: {#tip-example .callout-tip}
## Cross-Referencing a Tip

Add an ID starting with `#tip-` to reference a tip.
:::

See @tip-example...
```

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

### Start live preview with quarto preview

Source: https://quarto.org/docs/output-formats/hugo.html

Run from the root of a Hugo website. Automatically runs hugo serve and monitors .qmd/.ipynb files for changes.

```bash
cd my-hugo-website
quarto preview
```

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

### Document YAML with both formats

Source: https://quarto.org/docs/output-formats/html-multi-format.html

Example document YAML that lists both HTML and PDF formats to get an HTML document with a link to the PDF format, because the format option is not merged across project and document levels.

```yaml
format: 
  html: default
  pdf: default
```

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

### _publish.yml example

Source: https://quarto.org/docs/publishing/posit-connect-cloud.html

Example _publish.yml file specifying the publishing destination. Manually create this file with your site's id and url to publish to an existing site.

```yaml
- source: project
  posit-connect-cloud:
    - id: "5f3abafe-68f9-4c1d-835b-9d668b892001"
      url: "https://connect.posit.cloud/content/5f3abafe-68f9-4c1d-835b-9d668b892001"
```

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

### Progressive line highlighting with |6|9 in Python code block

Source: https://quarto.org/docs/presentations/revealjs/

Use the code-line-numbers attribute with pipe-separated values to progressively highlight lines across steps. This example starts with all lines, then highlights line 6, then line 9.

```markdown
```{.python code-line-numbers="|6|9"}
import numpy as np
import matplotlib.pyplot as plt

r = np.arange(0, 2, 0.01)
theta = 2 * np.pi * r
fig, ax = plt.subplots(subplot_kw={'projection': 'polar'})
ax.plot(theta, r)
ax.set_rticks([0.5, 1, 1.5, 2])
ax.grid(True)
plt.show()
```
```

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

### Create a new blog project with quarto create project

Source: https://quarto.org/docs/websites/website-blog.html

Use the `quarto create project` command with the `blog` type to scaffold a new blog in the specified directory. The command is run from the Terminal.

```bash
quarto create project blog myblog
```

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

### Install extension from a local file

Source: https://quarto.org/docs/cli/add.html

Installs an extension from a local ZIP file by specifying the path to the file.

```bash
quarto add <path-to-zip>
```

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

### MailChimp subscription widget HTML

Source: https://quarto.org/docs/websites/website-blog.html

HTML snippet for a minimal MailChimp subscription widget. Requires replacing <site_url> with your blog's specific URL and adding your own form action. This example is provided as a starting point and will not work without customization.

```html
<span style="font-weight: 600;">Subscribe</span>

<!-- Begin Mailchimp Signup Form -->
<link href="http://cdn-images.mailchimp.com/embedcode/slim-10_7_dtp.css" rel="stylesheet" type="text/css">
<style type="text/css">
    #mc_embed_signup{background:#fff; clear:left; font:14px Helvetica,Arial,sans-serif;  width:170px;}
    /* Add your own Mailchimp form style overrides in your site stylesheet or in this style block.
       We recommend moving this block and the preceding CSS link to the HEAD of your HTML file. */
    #mc-embedded-subscribe-form{margin-left:-5px;}
</style>
<div id="mc_embed_signup">
<form action="<site_url>" method="post" id="mc-embedded-subscribe-form" name="mc-embedded-subscribe-form" class="validate" target="_blank" novalidate>
    <div id="mc_embed_signup_scroll">

    <input type="email" value="" name="EMAIL" class="email" id="mce-EMAIL" placeholder="email address" required>
    <!-- real people should not fill this in and expect good things - do not remove this or risk form bot signups-->
    <div style="position: absolute; left: -5000px;" aria-hidden="true"><input type="text" name="b_f718424fc5df77c22533bdaa6_a3c37fb57b" tabindex="-1" value=""></div>
        <div class="optionalParent">
            <div class="clear foot" style="margin-top: 10px;">
                <input type="submit" value="Subscribe" name="subscribe" id="mc-embedded-subscribe" class="button">
                <p class="brandingLogo"></p>
            </div>
        </div>
    </div>
</form>
</div>

<!--End mc_embed_signup-->
```

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

### Example custom.scss theme file

Source: https://quarto.org/docs/presentations/revealjs/themes.html

A Sass theme file with `scss:defaults` for variables and `scss:rules` for CSS rules. Variables start with `$` and CSS rules targeting Reveal content should use the `.reveal .slide` prefix to override defaults.

```scss
/*-- scss:defaults --*/

$body-bg: #191919;
$body-color: #fff;
$link-color: #42affa;

/*-- scss:rules --*/

.reveal .slide blockquote {
  border-left: 3px solid $text-muted;
  padding-left: 0.5em;
}
```

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

### Preview a Quarto document or notebook

Source: https://quarto.org/docs/computations/julia.html

Starts a live preview for HTML or PDF output. Use `--to pdf` for PDF preview, and specify a `.ipynb` file to preview a notebook.

```bash
# preview as html
quarto preview document.qmd

# preview as pdf
quarto preview document.qmd --to pdf

# preview a jupyter notebook
quarto preview document.ipynb
```

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

### quarto call engine julia status - example output

Source: https://quarto.org/docs/computations/julia.html

Shows the output of the `status` command, displaying server and worker process information such as start time, version, environment, PID, port, Julia version, timeout, and worker details.

```bash
$ quarto call engine julia status
QuartoNotebookRunner server status:
  started at: 9:44:31 (47 seconds ago)
  runner version: 0.15.0
  environment: /Users/username/Library/Caches/quarto/julia/
  pid: 42008
  port: 8000
  julia version: 1.11.4
  timeout: 5 minutes
  workers active: 1
    worker 1:
      path: /Users/username/notebook.qmd
      run started: 9:44:38 (40 seconds ago)
      run finished: -
      timeout: 5 minutes
      pid: 42026
      exe: `julia`
      exeflags: ["--color=yes"]
      env: ["JULIA_PROJECT=@."]
```

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

### Preview the blog with quarto preview

Source: https://quarto.org/docs/websites/website-blog.html

Use the `quarto preview` command to render and preview the blog. The preview opens in a new web browser and updates automatically when source files are edited.

```bash
quarto preview myblog
```

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

### Excluding scripts from rendering in _quarto.yml

Source: https://quarto.org/docs/computations/render-scripts.html

Example _quarto.yml configuration that creates an explicit render list to exclude 'utils.py' from rendering in a Quarto project. This is rarely needed because scripts typically don't start with a YAML block unless authored for report rendering.

```yaml
project:
  type: website
  render:
    - "*.{qmd,R,py}"
    - "!utils.py"
```

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

### Minimal LaTeX template using pandoc.tex() partial (my-template.tex)

Source: https://quarto.org/docs/journals/templates.html

A minimal LaTeX template that includes the built-in pandoc.tex() partial to get Pandoc configuration for highlighting, tables, graphics, lists, citations, and header includes. Use this as a starting point for a custom template.

```latex
\documentclass{scrartcl}
$pandoc.tex()$
\begin{document}
$body$
\end{document}

```

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

### Publish project (prompt for provider)

Source: https://quarto.org/docs/cli/publish.html

Runs quarto publish without arguments to publish the current project, prompting for the provider.

```bash
quarto publish
```

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

### R dplyr pipeline with line annotations

Source: https://quarto.org/docs/authoring/code-annotation.html

Example of an R code block using line-based annotations (1 and 2) to describe steps in a dplyr pipeline. The annotation numbers are placed at the start of the lines they annotate, and the annotation text is provided in an ordered list below the code block.

```R
library(tidyverse)
library(palmerpenguins)
1penguins |>
2  mutate(
    bill_ratio = bill_depth_mm / bill_length_mm,
    bill_area  = bill_depth_mm * bill_length_mm
  )

```

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

### Install TinyTeX with quarto install

Source: https://quarto.org/docs/cli/install.html

Installs TinyTeX, a LaTeX distribution, using the quarto install command.

```bash
quarto install tinytex
```

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

### Preview the Quarto website locally

Source: https://quarto.org/docs/publishing/hugging-face.html

Run this command from the root of the cloned Hugging Face Space repository to preview the Quarto website in the `src/` directory.

```bash
quarto preview src
```

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

### Check Quarto installation

Source: https://quarto.org/docs/cli/check.html

Runs 'quarto check install' to verify the Quarto installation.

```bash
quarto check install
```

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

### Terminal: Preview hello.qmd

Source: https://quarto.org/docs/get-started/hello/text-editor.html

Command to start a live preview of the document in a web browser. This is used during authoring to see changes as you edit.

```bash
quarto preview hello.qmd
```

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

### Install R packages with renv

Source: https://quarto.org/docs/projects/virtual-environments.html

Shows standard installation from CRAN using install.packages and GitHub installation using renv::install.

```r
install.packages("ggplot2")      # install from CRAN
renv::install("tidyverse/dplyr") # install from GitHub
```

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

### Preview a Quarto book project from the terminal

Source: https://quarto.org/docs/books/

Run this command to render and preview the book. The preview opens in a new web browser and updates automatically as you edit and save source files like index.qmd or intro.qmd.

```bash
quarto preview mybook
```
Tokens:
Raw