cscheid / quarto-vscode

Quarto extension for VS Code

quarto-vscode

VS Code extension for the Quarto scientific and technical publishing system. This extension provides language support for Quarto .qmd files, including:

• Syntax highlighting for markdown and embedded languages
• Commands and key-bindings for running cells and selected line(s)
• Completion for embedded languages (e.g. Python, R, LaTeX, etc.)
• Completion and diagnostics for project files and document/cell options
• Code snippets for common markdown constructs
• Code folding and document outline for navigation within documents
• Workspace symbol provider for navigation across project files

Installation

The easiest way to install is directly from within VS Code (search extensions for "quarto").

You can also install from the VS Code Extension Marketplace or directly from a VISX extension file.

Features

Code Cells

There are a variety of tools that make it easier to edit and execute code cells. Editing tools include syntax highlighting, code folding, code completion, and signature tips:

For Python cells, commands are available to execute the current cell, previous cells, or the currently selected line(s). Cell output is shown side by side in the Jupyter interactive console:

Execute the current cell with Ctrl+Shift+Enter, the current line(s) with Ctrl+Enter, or previous cells with Ctrl+Alt+P (note that on the Mac you should use Cmd rather than Ctrl as the prefix for all Quarto keyboard shortcuts).

Enhanced features for embedded languages (e.g. completion, code execution) can be enabled by installing one or more of these other extensions:

• Python Extension
• R Extension
• LaTeX Workshop

YAML Intelligence

YAML code completion is available for project files, YAML front matter, and executable cell options:

If you have incorrect YAML it will also be highlighted when documents are saved:

Note that YAML intelligence features require version 0.9.44 or later of the Quarto CLI.

Code Snippets

Code snippets are templates that make it easier to enter repeating code patterns (e.g. code blocks, callouts, divs, etc.). Execute the Insert Snippet command within a Quarto document to insert a markdown snippet:

Document Navigation

If you have a large document use the outline view for quick navigation between sections:

You can also use the Go to Symbol in Editor command (Ctrl+Shift+O) keyboard shortcut for type-ahead navigation of the current document's outline.

Use the Go to File command (Ctrl+P) to navigate to other files and the Go to Symbol in Workspace command (Ctrl+T) for type-ahead navigation to all headings in the workspace:

VISX Install

You can alternatively download and install the extension from the command line as follows:

1. Download the extension file: Quarto VS Code (VISX)

2. Install from the command line with:

   code --install-extension quarto-1.6.0.vsix

Note that in order to use the code command to perform the installation you may need to open the VS Code Command Palette (Ctrl+Shift+P) and type "shell command" to execute the Shell Command: Install 'code' command in PATH command. This will make sure that code can be invoked from the command line on your system.