quarto-web Documentation

Quarto dashboards support a wide range of layout, data display, and interactivity features. You can learn more about specific dashboard components through the following guides:

• Layout: Control the navigation bar and arrange content using pages, rows, columns, tabsets, and cards.
• Data Display: Display data using plots, tables, value boxes, and text.
• Inputs: Implement interactive dashboards by placing inputs in sidebars, toolbars, or attaching them directly to cards.
• Theming: Customize fonts, colors, and general dashboard appearance.
• Parameters: Create dashboard variants by defining parameters and passing distinct values via the command line.
• Interactivity: Implement flexible data exploration through various interactive methods.
• Deployment: Deploy either static dashboards (hosted on any web host) or Shiny dashboards (requiring a Shiny Server).

Quarto provides three distinct ways to author documents depending on your workflow:

1. Source Code Editor: For editing .qmd documents as plain text.
2. Visual Editor: A WYSIWYG (What You See Is What You Get) interface for editing .qmd documents.
3. Notebook Editor: Specifically for editing .ipynb notebooks.

Consult the specific documentation for the Visual Editor or Notebook Editor for detailed guidance on those interfaces.

The Prerelease Extension provides shortcodes that automatically detect if a specific feature version has been released based on the version key in your _quarto.yml (or _quarto-prerelease-docs.yml when using the prerelease-docs profile). This allows you to show or hide content and adjust URLs dynamically as features move from development to stable release.

Shortcodes available:
- `prerelease-docs-url`
- `prerelease-callout`

Depending on your workflow and the file type you are editing, you can choose between different editor modes:

1. Source Editor: The traditional text-based editor used in Code-OSS.
2. Visual Editor: Best for WYSIWYG (What You See Is What You Get) editing of .qmd documents.
3. Notebook Editor: Specifically designed for editing .ipynb notebooks.

When using server: shiny, you can define interactive UI elements using shiny.express.ui. These elements update a reactive input object. You can then use decorators like @render.plot to create outputs that automatically update whenever the corresponding input values change.

from shiny.express import render, ui

# Define inputs
ui.input_select("x", "Variable:", choices=["bill_length_mm", "bill_depth_mm"])
ui.input_checkbox("rug", "Show rug marks", value = False)

# Define reactive output
@render.plot
def displot():
    # Access inputs via input.<name>()
    sns.displot(
        data=penguins, 
        x=input.x(), 
        rug=input.rug()
    )

To reduce start-up latency during interactive sessions, Quarto maintains a daemon with a running Jupyter kernel for each document. This allows subsequent renders to proceed immediately without waiting for a new kernel to start.

Important Behaviors:

• Interactive vs. Batch: Daemons are only created during interactive sessions. They are not created when rendering without an active TTY or during batch rendering (e.g., rendering a Quarto Project).
• Windows Support: By default, Quarto does not use a daemon on Windows because some systems restrict the required socket connections. You must enable it explicitly if needed.

While Quarto cannot guarantee 100% compliance, you can satisfy many requirements through proper document structure:

1. Metadata: Use YAML fields like title, author, date, and lang. These are propagated to the PDF metadata.
2. Tagging:
   • Typst: PDF tagging is always enabled.
   • LaTeX: Pandoc enables PDF tagging when you specify a standard that requires it (e.g., PDF/UA standards or PDF/A "a" variants like a-2a).
3. Alt Text: Ensure you provide alt text for images using the fig-alt attribute. This text is passed through to the PDF for screen readers.

Quarto allows resolving shortcodes inside element attributes such as headers, divs, spans, images, and links.

Requirement: To use shortcodes within attributes, you must specify the attributes using single quotes.

[Link text]('{url = env(VAR_NAME)}')$