Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -691,6 +691,8 @@ format:
filters:
- filters/tools-tabset.lua
- filters/color-box.lua
- at: post-quarto
path: filters/include-dark.lua

freeze: true

Expand Down
4 changes: 1 addition & 3 deletions docs/authoring/diagrams.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,10 @@ There are a variety of tools available to improve your productivity authoring di

3) [RStudio](https://www.rstudio.com/products/rstudio/download/) includes support for editing and previewing `.mmd` and `.dot` files (with help from the [DiagrammeR](https://rich-iannone.github.io/DiagrammeR/) package).

4) The Quarto [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) supports live preview of diagrams embedded in `.qmd` files and in `.mmd` and `.dot` files:
4) The Quarto Extension for VS Code and Positron (available on both [OpenVSX](https://open-vsx.org/extension/quarto/quarto) and [Microsoft's marketplace](https://marketplace.visualstudio.com/items?itemName=quarto.quarto)) supports live preview of diagrams embedded in `.qmd` files and in `.mmd` and `.dot` files:

![](images/vscode-graphviz.gif){.border fig-alt="A Quarto document being edited in Visual Studio Code, with a live preview of the currenly edited diagram shown in a pane to the right"}

Note that you should be sure to have installed the [very latest](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) version of the Quarto VS Code extension to try this out.

## Cross-References

Diagrams can be treated as figures the same way that images and plot output are. For example, if we added the following figure options to the diagram above:
Expand Down
22 changes: 21 additions & 1 deletion docs/books/book-basics.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,26 @@ Follow the Quick Start for your tool of choice to get a simple book up and runni

::: {.panel-tabset group="tools-tabset"}

### Positron

To create a new book project within Positron, execute the **Quarto: Create Project** command from the command-palette:

![](/docs/websites/images/positron-create-project-command.png){.include-dark .border}

Then, select **Book Project**:

![](images/positron-create-project-book.png){.include-dark .border}

You'll be prompted to select a parent directory to create the project within. Then, you'll be asked to name the directory for your book project:

![](/docs/websites/images/positron-create-project-directory.png){.include-dark .border}

The new book project will be created and opened within Positron. Click the **Preview** button (![](/docs/tools/images/vscode-preview-icon.svg){.light-content fig-alt="Preview icon"}![](/docs/tools/images/vscode-preview-icon-white.svg){.dark-content fig-alt="Preview icon"}) to preview the book:

![](images/positron-create-project-render-book.png){.include-dark .border}

The preview will show to the right of the source file. As you re-render `index.qmd` or render other files like `intro.qmd`, the preview is automatically updated.

### VS Code

To create a new book project within VS Code, execute the **Quarto: Create Project** command from the command-palette:
Expand All @@ -48,7 +68,7 @@ You'll be prompted to select a parent directory to create the project within. Th

![](/docs/websites/images/vscode-create-project-directory.png){.border}

The new book project will be created and opened within VS Code. Click the **Preview** button (![](/docs/tools/images/vscode-preview-icon.svg){fig-alt="Preview icon"}) to preview the book:
The new book project will be created and opened within VS Code. Click the **Preview** button (![](/docs/tools/images/vscode-preview-icon.svg){.light-content fig-alt="Preview icon"}![](/docs/tools/images/vscode-preview-icon-white.svg){.dark-content fig-alt="Preview icon"}) to preview the book:

![](/docs/websites/images/vscode-create-project-render-book.png)

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/computations/_jupyter-authoring-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ quarto preview document.ipynb

In addition to including executable {{< meta jupyter-language >}} code chunks in a Quarto document, you can also embed cells from an external Jupyter Notebook (`.ipynb`). See [Embedding Jupyter Notebook Cells](/docs/authoring/notebook-embed.qmd) for more details.

## Positron

{{< include _positron.md >}}

## VS Code

The [Quarto Extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) for VS Code provides a variety of tools for working with `.qmd` files in VS Code. The extension integrates directly with the {{< meta vscode-extension >}} to provide the following {{< meta jupyter-language >}}-specific capabilities:
Expand Down
12 changes: 12 additions & 0 deletions docs/computations/_positron.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
The [Quarto Extension](https://open-vsx.org/extension/quarto/quarto) is bundled with Positron, and provides a variety of tools for working with `.qmd` files. The extension integrates directly with {{< meta positron-extension>}} to provide code completion, cell execution and side-by-side preview of Quarto documents.

![]({{< meta positron-screenshot >}}){.include-dark .border fig-alt="Screen shot of qmd file open in Positron with source markdown shown in Editor pane and a rendered document shown in the Viewer Pane."}

The extension includes a **Quarto: Preview** command that can be accessed via the Command Palette, the keyboard shortcut {{< kbd mac=Command-Shift-K win=Control-Shift-K linux=Control-Shift-K >}}, or a **Preview** button (![](/docs/tools/images/vscode-preview-icon.svg){.light-content fig-alt="Preview icon"}![](/docs/tools/images/vscode-preview-icon-white.svg){.dark-content fig-alt="Preview icon"}) in the editor toolbar.
After rendering, a preview is displayed in the Viewer pane within Positron.

You can read more about using Positron in [Tools: Positron](/docs/tools/positron/index.qmd).

::: {.content-visible unless-meta="is_r"}
You can also use the Positron notebook editor to create `.ipynb` notebooks that you will render with Quarto. The [Jupyter Lab](#jupyter-lab) section discusses using notebooks with Quarto in the context of Jupyter Lab, but the same concepts apply to Positron.
:::
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/computations/inline-code.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ If you need to generate a dynamic caption, instead of using the `fig-cap` or `tb

## Usage in Notebooks

Inline expressions are always evaluated when rendering and previewing `.qmd` files. However, for notebooks you need to execute the notebook with Quarto to evaluate inline expressions (i.e. they won't be evaluated within the JupyterLab, VS Code, or PyCharm notebook editor).
Inline expressions are always evaluated when rendering and previewing `.qmd` files. However, for notebooks you need to execute the notebook with Quarto to evaluate inline expressions (i.e. they won't be evaluated within the JupyterLab, Positron, VS Code, or PyCharm notebook editor).

You can work in your favorite notebook front-end without Quarto execution, then once you are ready to publish execute the notebook during rendering as follows:

Expand Down
2 changes: 2 additions & 0 deletions docs/computations/julia.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Using Julia"
positron-extension: "the [Julia Extension](https://www.julia-vscode.org/docs)"
positron-screenshot: "images/positron-hello-julia.png"
jupyter-language: "Julia"
jupyter-screenshot: "![](images/julia-jupyter.png){.border fig-alt='Side-by-side preview of notebook on the left and live preview in the browser on the right.'}"
vscode-extension: "[Julia Extension](https://www.julia-vscode.org/docs)"
Expand Down
2 changes: 2 additions & 0 deletions docs/computations/python.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "Using Python"
positron-extension: "Positron's native Python support"
positron-screenshot: "/docs/get-started/hello/images/positron-hello-python.png"
jupyter-language: "Python"
jupyter-screenshot: "![](/docs/get-started/hello/images/jupyter-basics.png){.border fig-alt='A Jupyter notebook titled Quarto Basics containing some text, a code cell, and the result of the code cell, which is a line plot on a polar axis.'}"
vscode-extension: "[Python Extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)"
Expand Down
8 changes: 7 additions & 1 deletion docs/computations/r.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: "Using R"
positron-extension: "Positron's native R support"
positron-screenshot: "/docs/get-started/hello/images/positron-hello-r.png"
is_r: true
---

## Overview
Expand Down Expand Up @@ -101,6 +104,9 @@ Quarto will select a version of R by looking on the system `PATH`. In addition,

{{< include ../tools/_rstudio.md >}}

## Positron

{{< include _positron.md >}}

## VS Code

Expand All @@ -114,7 +120,7 @@ The [Quarto Extension](https://marketplace.visualstudio.com/items?itemName=quart

You can install the VS Code extension by searching for 'quarto' in the extensions panel or from the [extension marketplace](https://marketplace.visualstudio.com/items?itemName=quarto.quarto).

The VS Code extension includes a **Quarto: Preview** command that can be accessed via the Command Palette, the keyboard shortcut {{< kbd mac=Command-Shift-K win=Control-Shift-K linux=Control-Shift-K >}}, or a **Preview** button (![](/docs/tools/images/vscode-preview-icon.svg){fig-alt="Preview icon"}) in the editor.
The VS Code extension includes a **Quarto: Preview** command that can be accessed via the Command Palette, the keyboard shortcut {{< kbd mac=Command-Shift-K win=Control-Shift-K linux=Control-Shift-K >}}, or a **Preview** button (![](/docs/tools/images/vscode-preview-icon.svg){.light-content fig-alt="Preview icon"}![](/docs/tools/images/vscode-preview-icon-white.svg){.dark-content fig-alt="Preview icon"}) in the editor.
After rendering, a preview is displayed in a pane within VS Code alongside your document.

You can read more about using VS Code in [Tools: VS Code](/docs/tools/vscode/index.qmd).
Expand Down
2 changes: 1 addition & 1 deletion docs/dashboards/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Quarto Dashboards make it easy to create interactive dashboards using Python, R,

- Flexible and easy to specify row and column-based [Layouts](layout.qmd). Components are intelligently re-sized to fill the browser and adapted for display on mobile devices.

- Author using any notebook editor ([JupyterLab](/docs/tools/jupyter-lab.qmd), etc.) or in plain text markdown with any text editor ([VS Code](/docs/tools/vscode/index.qmd), [RStudio](/docs/tools/rstudio.qmd), [Neovim](/docs/tools/neovim.qmd), etc.)
- Author using any notebook editor ([JupyterLab](/docs/tools/jupyter-lab.qmd), etc.) or in plain text markdown with any text editor ([VS Code](/docs/tools/vscode/index.qmd), [Positron](/docs/tools/positron/index.qmd), [RStudio](/docs/tools/rstudio.qmd), [Neovim](/docs/tools/neovim.qmd), etc.)

- Dashboards can be deployed as static web pages (no special server required) or you can optionally integrate a backend [Shiny Server](/docs/dashboards/interactivity/shiny-python/index.qmd) for enhanced interactivity.

Expand Down
2 changes: 1 addition & 1 deletion docs/dashboards/interactivity/shiny-python/execution.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,6 @@ To learn more about Shiny for Python interactive documents see the following art

- [Input Layout](/docs/dashboards/inputs.qmd) describes various ways to layout inputs (sidebars, input panels, attaching inputs directly to cards, etc.).

- [Running Dashboards](running.qmd) covers how to run interactive dashboards both within VS Code and at the command line, as well as how to deploy them to end users.
- [Running Dashboards](running.qmd) covers how to run interactive dashboards both within VS Code, Positron, and at the command line, as well as how to deploy them to end users.

- [Shiny for Python](https://shiny.posit.co/py/) provides in-depth documentation on all of the available UI and ouput widgets, as well as conceptual discussions on how things work.
2 changes: 1 addition & 1 deletion docs/dashboards/interactivity/shiny-python/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ To learn more about Shiny for Python interactive documents see the following art

[Input Layout](/docs/dashboards/inputs.qmd) describes various ways to layout Shiny inputs (sidebars, input panels, attaching inputs directly to cards, etc.)

[Running Dashboards](running.qmd) covers in more depth how to run Shiny dashboards both within VS Code and at the command line, as well as how to deploy them to end users.
[Running Dashboards](running.qmd) covers in more depth how to run Shiny dashboards both within VS Code, Positron, and at the command line, as well as how to deploy them to end users.

[Execution Contexts](execution.qmd) goes in depth on when different code cells run (e.g. rendering vs. serving).

Expand Down
8 changes: 3 additions & 5 deletions docs/dashboards/interactivity/shiny-python/running.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,20 @@ lightbox: auto

There are a number of ways to run Shiny for Python interactive documents:

1. Use the **Quarto: Preview** command within VS Code.
1. Use the **Quarto: Preview** command within VS Code or Positron.
2. Use the `quarto preview` command line interface with any editor.
3. Deploy them to a server for use by a wider audience.

We'll cover all of these scenarios in depth here.

{{< include _shiny-requirements.qmd >}}

## VS Code
## VS Code and Positron

The [Quarto VS Code Extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) provides integrated support for previewing Shiny interactive documents (just use the **Quarto: Preview** command as you normally would with a static document):
The Quarto Extension for VS Code and Positron (available on both [OpenVSX](https://open-vsx.org/extension/quarto/quarto) and [Microsoft's marketplace](https://marketplace.visualstudio.com/items?itemName=quarto.quarto)) provides integrated support for previewing Shiny interactive documents (just use the **Quarto: Preview** command as you normally would with a static document):

![](images/preview-dashboard.png){.border fig-alt="Screenshot of VS Code with the file shiny.qmd open in the left pane. On the right is a pane labelled Quarto Preview showing the live dashboard."}

Note that you need the very latest version of the VS Code extension (v1.105.0 or greater) to preview Shiny interactive documents.

## Command Line

If you are using another notebook or text editor, you can also preview Shiny interactive documents from the command line via `quarto preview`. This works the same for notebooks (`.ipynb`) and plain text markdown (`.qmd`). For example:
Expand Down
4 changes: 2 additions & 2 deletions docs/extensions/filters.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ You'll notice that one of the extensions (`spellcheck.lua`) has a file extension

### Quick Start

Here we'll describe how to create a simple filter extension. We'll use the `quarto create` command to do this. If you are using VS Code or RStudio you should execute `quarto create` within their respective integrated Terminal panes.
Here we'll describe how to create a simple filter extension. We'll use the `quarto create` command to do this. If you are using VS Code, Positron, or RStudio you should execute `quarto create` within their respective integrated Terminal panes.

To get started, execute `quarto create extension filter` within the parent directory where you'd like the filter extension to be created:

Expand All @@ -72,7 +72,7 @@ Creating extension at /Users/jjallaire/quarto/dev/fancy-header:
- Created example.qmd
```

If you are running within VS Code or RStudio a new window will open with the extension project.
If you are running within VS Code, Positron, or RStudio a new window will open with the extension project.

Here's what the contents of the files in `_extensions/fancy-header/` look like:

Expand Down
4 changes: 2 additions & 2 deletions docs/extensions/formats.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ quarto render document.qmd --to acm-html

## Quick Start

Here we'll describe how to create a simple HTML-based format extension. We'll use the `quarto create` command to do this. If you are using VS Code or RStudio you should execute `quarto create` within their respective integrated Terminal panes.
Here we'll describe how to create a simple HTML-based format extension. We'll use the `quarto create` command to do this. If you are using VS Code, Positron, or RStudio you should execute `quarto create` within their respective integrated Terminal panes.

To get started, execute `quarto create extension format:html` within the parent directory where you'd like the format to be created:

Expand All @@ -65,7 +65,7 @@ Creating extension at /Users/jjallaire/quarto/dev/lexdoc:
- Created template.qmd
```

If you are running within VS Code or RStudio a new window will open with the extension project.
If you are running within VS Code, Positron, or RStudio a new window will open with the extension project.

::: {.callout-note appearance="simple"}
Note that this example creates a format that is derivative of the Quarto base `html` format. You can similarly create formats that are derivative of `pdf`, `docx`, and `revealjs` as follows:
Expand Down
Loading